Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / dataflow_v1b3.projects.snapshots.html
blob: 928844441337c81d11edd85fd77bc2460ad42388 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <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 -0700[diff] [blame]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">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]84 <code><a href="#list">list(projectId, jobId=None, location=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Lists snapshots.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <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 -0700[diff] [blame]93 <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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;pubsubMetadata&quot;: [ # PubSub snapshot metadata.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 { # Represents a Pubsub snapshot.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]111 &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]112 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
113 &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 },
115 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]116 &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
117 &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]118 &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
119 &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
120 &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
121 &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]122 &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]123 &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 }</pre>
125</div>
126
127<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]128 <code class="details" id="list">list(projectId, jobId=None, location=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 <pre>Lists snapshots.
130
131Args:
132 projectId: string, The project ID to list snapshots for. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]133 jobId: string, If specified, list snapshots created from this job.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]134 location: string, The location to list snapshots in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # List of snapshots.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;snapshots&quot;: [ # Returned snapshots.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 { # Represents a snapshot of a job.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;pubsubMetadata&quot;: [ # PubSub snapshot metadata.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 { # Represents a Pubsub snapshot.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]148 &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]149 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
150 &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]151 },
152 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]153 &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
154 &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]155 &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
156 &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
157 &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
158 &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]159 &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]160 &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 },
162 ],
163 }</pre>
164</div>
165
166</body></html>