• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, 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
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, 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.locations.html">locations</a> . <a href="dataflow_v1b3.projects.locations.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="#delete">delete(projectId, location, snapshotId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a snapshot.</p>
83<p class="toc_element">
84  <code><a href="#get">get(projectId, location, snapshotId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets information about a snapshot.</p>
86<p class="toc_element">
87  <code><a href="#list">list(projectId, location, jobId=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists snapshots.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="close">close()</code>
92  <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96    <code class="details" id="delete">delete(projectId, location, snapshotId, x__xgafv=None)</code>
97  <pre>Deletes a snapshot.
98
99Args:
100  projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
101  location: string, The location that contains this snapshot. (required)
102  snapshotId: string, The ID of the snapshot. (required)
103  x__xgafv: string, V1 error format.
104    Allowed values
105      1 - v1 error format
106      2 - v2 error format
107
108Returns:
109  An object of the form:
110
111    { # Response from deleting a snapshot.
112}</pre>
113</div>
114
115<div class="method">
116    <code class="details" id="get">get(projectId, location, snapshotId, x__xgafv=None)</code>
117  <pre>Gets information about a snapshot.
118
119Args:
120  projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
121  location: string, The location that contains this snapshot. (required)
122  snapshotId: string, The ID of the snapshot. (required)
123  x__xgafv: string, V1 error format.
124    Allowed values
125      1 - v1 error format
126      2 - v2 error format
127
128Returns:
129  An object of the form:
130
131    { # Represents a snapshot of a job.
132  &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
133  &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
134  &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
135  &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
136  &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
137  &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
138    { # Represents a Pubsub snapshot.
139      &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
140      &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
141      &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
142    },
143  ],
144  &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
145  &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
146  &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
147  &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
148}</pre>
149</div>
150
151<div class="method">
152    <code class="details" id="list">list(projectId, location, jobId=None, x__xgafv=None)</code>
153  <pre>Lists snapshots.
154
155Args:
156  projectId: string, The project ID to list snapshots for. (required)
157  location: string, The location to list snapshots in. (required)
158  jobId: string, If specified, list snapshots created from this job.
159  x__xgafv: string, V1 error format.
160    Allowed values
161      1 - v1 error format
162      2 - v2 error format
163
164Returns:
165  An object of the form:
166
167    { # List of snapshots.
168  &quot;snapshots&quot;: [ # Returned snapshots.
169    { # Represents a snapshot of a job.
170      &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
171      &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
172      &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
173      &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
174      &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
175      &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
176        { # Represents a Pubsub snapshot.
177          &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
178          &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
179          &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
180        },
181      ],
182      &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
183      &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
184      &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
185      &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
186    },
187  ],
188}</pre>
189</div>
190
191</body></html>