Debian Codegraph @

docs/dyn/dataflow_v1b3.projects.snapshots.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.snapshots.html">snapshots</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(projectId, snapshotId, location=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets information about a snapshot.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(projectId, jobId=None, location=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists snapshots.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="get">get(projectId, snapshotId, location=None, x__xgafv=None)</code>
94 <pre>Gets information about a snapshot.
95
96 Args:
97 projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
98 snapshotId: string, The ID of the snapshot. (required)
99 location: string, The location that contains this snapshot.
100 x__xgafv: string, V1 error format.
101 Allowed values
102 1 - v1 error format
103 2 - v2 error format
104
105 Returns:
106 An object of the form:
107
108 { # Represents a snapshot of a job.
109 &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
110 &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
111 &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
112 &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
113 &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
114 &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
115 { # Represents a Pubsub snapshot.
116 &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
117 &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
118 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
119 },
120 ],
121 &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
122 &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
123 &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
124 &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
125 }</pre>
126 </div>
127
128 <div class="method">
129 <code class="details" id="list">list(projectId, jobId=None, location=None, x__xgafv=None)</code>
130 <pre>Lists snapshots.
131
132 Args:
133 projectId: string, The project ID to list snapshots for. (required)
134 jobId: string, If specified, list snapshots created from this job.
135 location: string, The location to list snapshots in.
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141 Returns:
142 An object of the form:
143
144 { # List of snapshots.
145 &quot;snapshots&quot;: [ # Returned snapshots.
146 { # Represents a snapshot of a job.
147 &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
148 &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
149 &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
150 &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
151 &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
152 &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
153 { # Represents a Pubsub snapshot.
154 &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
155 &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
156 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
157 },
158 ],
159 &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
160 &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
161 &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
162 &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
163 },
164 ],
165 }</pre>
166 </div>
167
168 </body></html>