File: dataflow_v1b3.projects.snapshots.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (168 lines) | stat: -rw-r--r-- 5,560 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(projectId, snapshotId, location=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a snapshot.</p>
<p class="toc_element">
  <code><a href="#list">list(projectId, jobId=None, location=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists snapshots.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(projectId, snapshotId, location=None, x__xgafv=None)</code>
  <pre>Gets information about a snapshot.

Args:
  projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
  snapshotId: string, The ID of the snapshot. (required)
  location: string, The location that contains this snapshot.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a snapshot of a job.
  &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
  &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
  &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
  &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
  &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
    { # Represents a Pubsub snapshot.
      &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
      &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
      &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
    },
  ],
  &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
  &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
  &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
  &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(projectId, jobId=None, location=None, x__xgafv=None)</code>
  <pre>Lists snapshots.

Args:
  projectId: string, The project ID to list snapshots for. (required)
  jobId: string, If specified, list snapshots created from this job.
  location: string, The location to list snapshots in.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List of snapshots.
  &quot;snapshots&quot;: [ # Returned snapshots.
    { # Represents a snapshot of a job.
      &quot;creationTime&quot;: &quot;A String&quot;, # The time this snapshot was created.
      &quot;description&quot;: &quot;A String&quot;, # User specified description of the snapshot. Maybe empty.
      &quot;diskSizeBytes&quot;: &quot;A String&quot;, # The disk byte size of the snapshot. Only available for snapshots in READY state.
      &quot;id&quot;: &quot;A String&quot;, # The unique ID of this snapshot.
      &quot;projectId&quot;: &quot;A String&quot;, # The project this snapshot belongs to.
      &quot;pubsubMetadata&quot;: [ # Pub/Sub snapshot metadata.
        { # Represents a Pubsub snapshot.
          &quot;expireTime&quot;: &quot;A String&quot;, # The expire time of the Pubsub snapshot.
          &quot;snapshotName&quot;: &quot;A String&quot;, # The name of the Pubsub snapshot.
          &quot;topicName&quot;: &quot;A String&quot;, # The name of the Pubsub topic.
        },
      ],
      &quot;region&quot;: &quot;A String&quot;, # Cloud region where this snapshot lives in, e.g., &quot;us-central1&quot;.
      &quot;sourceJobId&quot;: &quot;A String&quot;, # The job this snapshot was created from.
      &quot;state&quot;: &quot;A String&quot;, # State of the snapshot.
      &quot;ttl&quot;: &quot;A String&quot;, # The time after which this snapshot will be automatically deleted.
    },
  ],
}</pre>
</div>

</body></html>