| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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.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="#delete">delete(projectId, location, snapshotId, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Deletes a snapshot.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(projectId, location, snapshotId, 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, location, jobId=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="delete">delete(projectId, location, snapshotId, x__xgafv=None)</code> |
| 89 | <pre>Deletes a snapshot. |
| 90 | |
| 91 | Args: |
| 92 | projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required) |
| 93 | location: string, The location that contains this snapshot. (required) |
| 94 | snapshotId: string, The ID of the snapshot. (required) |
| 95 | x__xgafv: string, V1 error format. |
| 96 | Allowed values |
| 97 | 1 - v1 error format |
| 98 | 2 - v2 error format |
| 99 | |
| 100 | Returns: |
| 101 | An object of the form: |
| 102 | |
| 103 | { # Response from deleting a snapshot. |
| 104 | }</pre> |
| 105 | </div> |
| 106 | |
| 107 | <div class="method"> |
| 108 | <code class="details" id="get">get(projectId, location, snapshotId, x__xgafv=None)</code> |
| 109 | <pre>Gets information about a snapshot. |
| 110 | |
| 111 | Args: |
| 112 | projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required) |
| 113 | location: string, The location that contains this snapshot. (required) |
| 114 | snapshotId: string, The ID of the snapshot. (required) |
| 115 | x__xgafv: string, V1 error format. |
| 116 | Allowed values |
| 117 | 1 - v1 error format |
| 118 | 2 - v2 error format |
| 119 | |
| 120 | Returns: |
| 121 | An object of the form: |
| 122 | |
| 123 | { # Represents a snapshot of a job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "pubsubMetadata": [ # PubSub snapshot metadata. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 125 | { # Represents a Pubsub snapshot. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "snapshotName": "A String", # The name of the Pubsub snapshot. |
| 127 | "topicName": "A String", # The name of the Pubsub topic. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 128 | "expireTime": "A String", # The expire time of the Pubsub snapshot. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 129 | }, |
| 130 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "creationTime": "A String", # The time this snapshot was created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 132 | "sourceJobId": "A String", # The job this snapshot was created from. |
| 133 | "state": "A String", # State of the snapshot. |
| 134 | "projectId": "A String", # The project this snapshot belongs to. |
| 135 | "ttl": "A String", # The time after which this snapshot will be automatically deleted. |
| 136 | "id": "A String", # The unique ID of this snapshot. |
| 137 | "description": "A String", # User specified description of the snapshot. Maybe empty. |
| 138 | "diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY |
| 139 | # state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 140 | }</pre> |
| 141 | </div> |
| 142 | |
| 143 | <div class="method"> |
| 144 | <code class="details" id="list">list(projectId, location, jobId=None, x__xgafv=None)</code> |
| 145 | <pre>Lists snapshots. |
| 146 | |
| 147 | Args: |
| 148 | projectId: string, The project ID to list snapshots for. (required) |
| 149 | location: string, The location to list snapshots in. (required) |
| 150 | jobId: string, If specified, list snapshots created from this job. |
| 151 | x__xgafv: string, V1 error format. |
| 152 | Allowed values |
| 153 | 1 - v1 error format |
| 154 | 2 - v2 error format |
| 155 | |
| 156 | Returns: |
| 157 | An object of the form: |
| 158 | |
| 159 | { # List of snapshots. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "snapshots": [ # Returned snapshots. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | { # Represents a snapshot of a job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "pubsubMetadata": [ # PubSub snapshot metadata. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 163 | { # Represents a Pubsub snapshot. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | "snapshotName": "A String", # The name of the Pubsub snapshot. |
| 165 | "topicName": "A String", # The name of the Pubsub topic. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 166 | "expireTime": "A String", # The expire time of the Pubsub snapshot. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 167 | }, |
| 168 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | "creationTime": "A String", # The time this snapshot was created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 170 | "sourceJobId": "A String", # The job this snapshot was created from. |
| 171 | "state": "A String", # State of the snapshot. |
| 172 | "projectId": "A String", # The project this snapshot belongs to. |
| 173 | "ttl": "A String", # The time after which this snapshot will be automatically deleted. |
| 174 | "id": "A String", # The unique ID of this snapshot. |
| 175 | "description": "A String", # User specified description of the snapshot. Maybe empty. |
| 176 | "diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY |
| 177 | # state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 178 | }, |
| 179 | ], |
| 180 | }</pre> |
| 181 | </div> |
| 182 | |
| 183 | </body></html> |