blob: 91de67f3f3aa4fd6810e083001ad58d9c5661a47 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(projectId, jobId=None, location=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Lists snapshots.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070093 <code class="details" id="get">get(projectId, snapshotId, location=None, x__xgafv=None)</code>
94 <pre>Gets information about a snapshot.
95
96Args:
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
105Returns:
106 An object of the form:
107
108 { # Represents a snapshot of a job.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800109 &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.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700114 &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800115 { # 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 ],
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -0700121 &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126</div>
127
128<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800129 <code class="details" id="list">list(projectId, jobId=None, location=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 <pre>Lists snapshots.
131
132Args:
133 projectId: string, The project ID to list snapshots for. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 jobId: string, If specified, list snapshots created from this job.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 location: string, The location to list snapshots in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # List of snapshots.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800145 &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.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700152 &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 { # 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 ],
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -0700159 &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800160 &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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700166</div>
167
168</body></html>