| 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="datafusion_v1beta1.html">Cloud Data Fusion API</a> . <a href="datafusion_v1beta1.projects.html">projects</a> . <a href="datafusion_v1beta1.projects.locations.html">locations</a> . <a href="datafusion_v1beta1.projects.locations.instances.html">instances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a new Data Fusion instance in the specified project and location.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a single Date Fusion instance.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets details of a single Data Fusion instance.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Gets the access control policy for a resource.</p> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists Data Fusion instances in the specified project and location.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Updates a single Data Fusion instance.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Restart a single Data Fusion instance.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p> |
| 109 | <p class="firstline">Upgrade a single Data Fusion instance.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <pre>Creates a new Data Fusion instance in the specified project and location. |
| 114 | |
| 115 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | parent: string, The instance's project and location in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | projects/{project}/locations/{location}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | The object takes the form of: |
| 120 | |
| 121 | { # Represents a Data Fusion instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 122 | # Next available ID: 23 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "availableVersion": [ # Available versions that the instance can be upgraded to using |
| 124 | # UpdateInstanceRequest. |
| 125 | { # The Data Fusion version. |
| 126 | "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | }, |
| 128 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "displayName": "A String", # Display name for an instance. |
| 130 | "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. |
| 131 | "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. |
| 132 | "createTime": "A String", # Output only. The time the instance was created. |
| 133 | "labels": { # The resource labels for instance to use to annotate any related underlying |
| 134 | # resources such as Compute Engine VMs. The character '=' is not allowed to |
| 135 | # be used within the labels. |
| 136 | "a_key": "A String", |
| 137 | }, |
| 138 | "updateTime": "A String", # Output only. The time the instance was last updated. |
| 139 | "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. |
| 140 | "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. |
| 141 | "type": "A String", # Required. Instance type. |
| 142 | "version": "A String", # Current version of Data Fusion. |
| 143 | "stateMessage": "A String", # Output only. Additional information about the current state of this Data |
| 144 | # Fusion instance if available. |
| 145 | "accelerators": [ # List of accelerators enabled for this CDF instance. |
| 146 | { # Identifies Data Fusion accelerators for an instance. |
| 147 | "acceleratorType": "A String", # The type of an accelator for a CDF instance. |
| 148 | }, |
| 149 | ], |
| 150 | "description": "A String", # Optional. An optional description of this instance. |
| 151 | "options": { # Map of additional options used to configure the behavior of |
| 152 | # Data Fusion instance. |
| 153 | "a_key": "A String", |
| 154 | }, |
| 155 | "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | # Fusion instance is to be created. |
| 157 | # are used for peering with the customer network. Configurations are optional |
| 158 | # when a public Data Fusion instance is to be created. However, providing |
| 159 | # these configurations allows several benefits, such as reduced network latency |
| 160 | # while accessing the customer resources from managed Data Fusion instance |
| 161 | # nodes, as well as access to the customer on-prem resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "network": "A String", # Name of the network in the customer project with which the Tenant Project |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 163 | # will be peered for executing pipelines. In case of shared VPC where the |
| 164 | # network resides in another host project the network should specified in |
| 165 | # the form of projects/{host-project-id}/global/networks/{network} |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 167 | # nodes. This range must not overlap with any other ranges used in the Data |
| 168 | # Fusion instance network. |
| 169 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "state": "A String", # Output only. The current state of this Data Fusion instance. |
| 171 | "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. |
| 172 | "name": "A String", # Output only. The name of this instance is in the form of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | # projects/{project}/locations/{location}/instances/{instance}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. |
| 175 | "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to |
| 176 | # true, all Data Fusion nodes will have private IP addresses and will not be |
| 177 | # able to access the public internet. |
| 178 | "serviceAccount": "A String", # Output only. Service account which will be used to access resources in |
| 179 | # the customer project." |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | instanceId: string, The name of the instance to create. |
| 183 | x__xgafv: string, V1 error format. |
| 184 | Allowed values |
| 185 | 1 - v1 error format |
| 186 | 2 - v2 error format |
| 187 | |
| 188 | Returns: |
| 189 | An object of the form: |
| 190 | |
| 191 | { # This resource represents a long-running operation that is the result of a |
| 192 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | # method returns no data on success, such as `Delete`, the response is |
| 195 | # `google.protobuf.Empty`. If the original method is standard |
| 196 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 197 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 198 | # is the original method name. For example, if the original method name |
| 199 | # is `TakeSnapshot()`, the inferred response type is |
| 200 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 202 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 204 | # originally returns it. If you use the default HTTP mapping, the |
| 205 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 206 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 207 | # different programming environments, including REST APIs and RPC APIs. It is |
| 208 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 209 | # three pieces of data: error code, error message, and error details. |
| 210 | # |
| 211 | # You can find out more about this error model and how to work with it in the |
| 212 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 213 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 214 | # message types for APIs to use. |
| 215 | { |
| 216 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 217 | }, |
| 218 | ], |
| 219 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 220 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 221 | # user-facing error message should be localized and sent in the |
| 222 | # google.rpc.Status.details field, or localized by the client. |
| 223 | }, |
| 224 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 225 | # contains progress information and common metadata such as create time. |
| 226 | # Some services might not provide such metadata. Any method that returns a |
| 227 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 228 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 229 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 230 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 231 | # If `true`, the operation is completed, and either `error` or `response` is |
| 232 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 233 | }</pre> |
| 234 | </div> |
| 235 | |
| 236 | <div class="method"> |
| 237 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 238 | <pre>Deletes a single Date Fusion instance. |
| 239 | |
| 240 | Args: |
| 241 | name: string, The instance resource name in the format |
| 242 | projects/{project}/locations/{location}/instances/{instance} (required) |
| 243 | x__xgafv: string, V1 error format. |
| 244 | Allowed values |
| 245 | 1 - v1 error format |
| 246 | 2 - v2 error format |
| 247 | |
| 248 | Returns: |
| 249 | An object of the form: |
| 250 | |
| 251 | { # This resource represents a long-running operation that is the result of a |
| 252 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 254 | # method returns no data on success, such as `Delete`, the response is |
| 255 | # `google.protobuf.Empty`. If the original method is standard |
| 256 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 257 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 258 | # is the original method name. For example, if the original method name |
| 259 | # is `TakeSnapshot()`, the inferred response type is |
| 260 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 262 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | # originally returns it. If you use the default HTTP mapping, the |
| 265 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 267 | # different programming environments, including REST APIs and RPC APIs. It is |
| 268 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 269 | # three pieces of data: error code, error message, and error details. |
| 270 | # |
| 271 | # You can find out more about this error model and how to work with it in the |
| 272 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 273 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 274 | # message types for APIs to use. |
| 275 | { |
| 276 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 277 | }, |
| 278 | ], |
| 279 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 280 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 281 | # user-facing error message should be localized and sent in the |
| 282 | # google.rpc.Status.details field, or localized by the client. |
| 283 | }, |
| 284 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 285 | # contains progress information and common metadata such as create time. |
| 286 | # Some services might not provide such metadata. Any method that returns a |
| 287 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 288 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 289 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 290 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 291 | # If `true`, the operation is completed, and either `error` or `response` is |
| 292 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 293 | }</pre> |
| 294 | </div> |
| 295 | |
| 296 | <div class="method"> |
| 297 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 298 | <pre>Gets details of a single Data Fusion instance. |
| 299 | |
| 300 | Args: |
| 301 | name: string, The instance resource name in the format |
| 302 | projects/{project}/locations/{location}/instances/{instance}. (required) |
| 303 | x__xgafv: string, V1 error format. |
| 304 | Allowed values |
| 305 | 1 - v1 error format |
| 306 | 2 - v2 error format |
| 307 | |
| 308 | Returns: |
| 309 | An object of the form: |
| 310 | |
| 311 | { # Represents a Data Fusion instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 312 | # Next available ID: 23 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "availableVersion": [ # Available versions that the instance can be upgraded to using |
| 314 | # UpdateInstanceRequest. |
| 315 | { # The Data Fusion version. |
| 316 | "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 317 | }, |
| 318 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 319 | "displayName": "A String", # Display name for an instance. |
| 320 | "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. |
| 321 | "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. |
| 322 | "createTime": "A String", # Output only. The time the instance was created. |
| 323 | "labels": { # The resource labels for instance to use to annotate any related underlying |
| 324 | # resources such as Compute Engine VMs. The character '=' is not allowed to |
| 325 | # be used within the labels. |
| 326 | "a_key": "A String", |
| 327 | }, |
| 328 | "updateTime": "A String", # Output only. The time the instance was last updated. |
| 329 | "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. |
| 330 | "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. |
| 331 | "type": "A String", # Required. Instance type. |
| 332 | "version": "A String", # Current version of Data Fusion. |
| 333 | "stateMessage": "A String", # Output only. Additional information about the current state of this Data |
| 334 | # Fusion instance if available. |
| 335 | "accelerators": [ # List of accelerators enabled for this CDF instance. |
| 336 | { # Identifies Data Fusion accelerators for an instance. |
| 337 | "acceleratorType": "A String", # The type of an accelator for a CDF instance. |
| 338 | }, |
| 339 | ], |
| 340 | "description": "A String", # Optional. An optional description of this instance. |
| 341 | "options": { # Map of additional options used to configure the behavior of |
| 342 | # Data Fusion instance. |
| 343 | "a_key": "A String", |
| 344 | }, |
| 345 | "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 346 | # Fusion instance is to be created. |
| 347 | # are used for peering with the customer network. Configurations are optional |
| 348 | # when a public Data Fusion instance is to be created. However, providing |
| 349 | # these configurations allows several benefits, such as reduced network latency |
| 350 | # while accessing the customer resources from managed Data Fusion instance |
| 351 | # nodes, as well as access to the customer on-prem resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | "network": "A String", # Name of the network in the customer project with which the Tenant Project |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 353 | # will be peered for executing pipelines. In case of shared VPC where the |
| 354 | # network resides in another host project the network should specified in |
| 355 | # the form of projects/{host-project-id}/global/networks/{network} |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 357 | # nodes. This range must not overlap with any other ranges used in the Data |
| 358 | # Fusion instance network. |
| 359 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | "state": "A String", # Output only. The current state of this Data Fusion instance. |
| 361 | "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. |
| 362 | "name": "A String", # Output only. The name of this instance is in the form of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 363 | # projects/{project}/locations/{location}/instances/{instance}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 364 | "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. |
| 365 | "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to |
| 366 | # true, all Data Fusion nodes will have private IP addresses and will not be |
| 367 | # able to access the public internet. |
| 368 | "serviceAccount": "A String", # Output only. Service account which will be used to access resources in |
| 369 | # the customer project." |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 370 | }</pre> |
| 371 | </div> |
| 372 | |
| 373 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 374 | <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | <pre>Gets the access control policy for a resource. |
| 376 | Returns an empty policy if the resource exists and does not have a policy |
| 377 | set. |
| 378 | |
| 379 | Args: |
| 380 | resource: string, REQUIRED: The resource for which the policy is being requested. |
| 381 | See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 382 | options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| 383 | |
| 384 | Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| 385 | rejected. |
| 386 | |
| 387 | Requests for policies with any conditional bindings must specify version 3. |
| 388 | Policies without any conditional bindings may specify any valid value or |
| 389 | leave the field unset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | x__xgafv: string, V1 error format. |
| 391 | Allowed values |
| 392 | 1 - v1 error format |
| 393 | 2 - v2 error format |
| 394 | |
| 395 | Returns: |
| 396 | An object of the form: |
| 397 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 398 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 399 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 400 | # |
| 401 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 402 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 403 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 404 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 405 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 406 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 407 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 408 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 409 | # expression that allows access to a resource only if the expression evaluates |
| 410 | # to `true`. A condition can add constraints based on attributes of the |
| 411 | # request, the resource, or both. |
| 412 | # |
| 413 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | # |
| 415 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 416 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 417 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | # "role": "roles/resourcemanager.organizationAdmin", |
| 419 | # "members": [ |
| 420 | # "user:mike@example.com", |
| 421 | # "group:admins@example.com", |
| 422 | # "domain:google.com", |
| 423 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 424 | # ] |
| 425 | # }, |
| 426 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 427 | # "role": "roles/resourcemanager.organizationViewer", |
| 428 | # "members": ["user:eve@example.com"], |
| 429 | # "condition": { |
| 430 | # "title": "expirable access", |
| 431 | # "description": "Does not grant access after Sep 2020", |
| 432 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 433 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 434 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 435 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 436 | # "etag": "BwWWja0YfJA=", |
| 437 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 438 | # } |
| 439 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 440 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 441 | # |
| 442 | # bindings: |
| 443 | # - members: |
| 444 | # - user:mike@example.com |
| 445 | # - group:admins@example.com |
| 446 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 447 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 448 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 449 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 450 | # - user:eve@example.com |
| 451 | # role: roles/resourcemanager.organizationViewer |
| 452 | # condition: |
| 453 | # title: expirable access |
| 454 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 456 | # - etag: BwWWja0YfJA= |
| 457 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 458 | # |
| 459 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 460 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 462 | # prevent simultaneous updates of a policy from overwriting each other. |
| 463 | # It is strongly suggested that systems make use of the `etag` in the |
| 464 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 465 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 466 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 467 | # ensure that their change will be applied to the same version of the policy. |
| 468 | # |
| 469 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 470 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 471 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 472 | # the conditions in the version `3` policy are lost. |
| 473 | "version": 42, # Specifies the format of the policy. |
| 474 | # |
| 475 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 476 | # are rejected. |
| 477 | # |
| 478 | # Any operation that affects conditional role bindings must specify version |
| 479 | # `3`. This requirement applies to the following operations: |
| 480 | # |
| 481 | # * Getting a policy that includes a conditional role binding |
| 482 | # * Adding a conditional role binding to a policy |
| 483 | # * Changing a conditional role binding in a policy |
| 484 | # * Removing any role binding, with or without a condition, from a policy |
| 485 | # that includes conditions |
| 486 | # |
| 487 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 488 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 489 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 490 | # the conditions in the version `3` policy are lost. |
| 491 | # |
| 492 | # If a policy does not include any conditions, operations on that policy may |
| 493 | # specify any valid version or leave the field unset. |
| 494 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 495 | { # Specifies the audit configuration for a service. |
| 496 | # The configuration determines which permission types are logged, and what |
| 497 | # identities, if any, are exempted from logging. |
| 498 | # An AuditConfig must have one or more AuditLogConfigs. |
| 499 | # |
| 500 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 501 | # the union of the two AuditConfigs is used for that service: the log_types |
| 502 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 503 | # AuditLogConfig are exempted. |
| 504 | # |
| 505 | # Example Policy with multiple AuditConfigs: |
| 506 | # |
| 507 | # { |
| 508 | # "audit_configs": [ |
| 509 | # { |
| 510 | # "service": "allServices" |
| 511 | # "audit_log_configs": [ |
| 512 | # { |
| 513 | # "log_type": "DATA_READ", |
| 514 | # "exempted_members": [ |
| 515 | # "user:jose@example.com" |
| 516 | # ] |
| 517 | # }, |
| 518 | # { |
| 519 | # "log_type": "DATA_WRITE", |
| 520 | # }, |
| 521 | # { |
| 522 | # "log_type": "ADMIN_READ", |
| 523 | # } |
| 524 | # ] |
| 525 | # }, |
| 526 | # { |
| 527 | # "service": "sampleservice.googleapis.com" |
| 528 | # "audit_log_configs": [ |
| 529 | # { |
| 530 | # "log_type": "DATA_READ", |
| 531 | # }, |
| 532 | # { |
| 533 | # "log_type": "DATA_WRITE", |
| 534 | # "exempted_members": [ |
| 535 | # "user:aliya@example.com" |
| 536 | # ] |
| 537 | # } |
| 538 | # ] |
| 539 | # } |
| 540 | # ] |
| 541 | # } |
| 542 | # |
| 543 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 544 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 545 | # aliya@example.com from DATA_WRITE logging. |
| 546 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 547 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 548 | # `allServices` is a special value that covers all services. |
| 549 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 550 | { # Provides the configuration for logging a type of permissions. |
| 551 | # Example: |
| 552 | # |
| 553 | # { |
| 554 | # "audit_log_configs": [ |
| 555 | # { |
| 556 | # "log_type": "DATA_READ", |
| 557 | # "exempted_members": [ |
| 558 | # "user:jose@example.com" |
| 559 | # ] |
| 560 | # }, |
| 561 | # { |
| 562 | # "log_type": "DATA_WRITE", |
| 563 | # } |
| 564 | # ] |
| 565 | # } |
| 566 | # |
| 567 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 568 | # jose@example.com from DATA_READ logging. |
| 569 | "logType": "A String", # The log type that this config enables. |
| 570 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 571 | # permission. |
| 572 | # Follows the same format of Binding.members. |
| 573 | "A String", |
| 574 | ], |
| 575 | }, |
| 576 | ], |
| 577 | }, |
| 578 | ], |
| 579 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 580 | # `condition` that determines how and when the `bindings` are applied. Each |
| 581 | # of the `bindings` must contain at least one member. |
| 582 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 583 | "role": "A String", # Role that is assigned to `members`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 584 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 585 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 586 | # NOTE: An unsatisfied condition will not allow user access via current |
| 587 | # binding. Different bindings, including their conditions, are examined |
| 588 | # independently. |
| 589 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 590 | # are documented at https://github.com/google/cel-spec. |
| 591 | # |
| 592 | # Example (Comparison): |
| 593 | # |
| 594 | # title: "Summary size limit" |
| 595 | # description: "Determines if a summary is less than 100 chars" |
| 596 | # expression: "document.summary.size() < 100" |
| 597 | # |
| 598 | # Example (Equality): |
| 599 | # |
| 600 | # title: "Requestor is owner" |
| 601 | # description: "Determines if requestor is the document owner" |
| 602 | # expression: "document.owner == request.auth.claims.email" |
| 603 | # |
| 604 | # Example (Logic): |
| 605 | # |
| 606 | # title: "Public documents" |
| 607 | # description: "Determine whether the document should be publicly visible" |
| 608 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 609 | # |
| 610 | # Example (Data Manipulation): |
| 611 | # |
| 612 | # title: "Notification string" |
| 613 | # description: "Create a notification string with a timestamp." |
| 614 | # expression: "'New message received at ' + string(document.create_time)" |
| 615 | # |
| 616 | # The exact variables and functions that may be referenced within an expression |
| 617 | # are determined by the service that evaluates it. See the service |
| 618 | # documentation for additional information. |
| 619 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 620 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 621 | # expression. |
| 622 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 623 | # reporting, e.g. a file name and a position in the file. |
| 624 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 625 | # describes the expression, e.g. when hovered over it in a UI. |
| 626 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 627 | # syntax. |
| 628 | }, |
| 629 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 630 | # `members` can have the following values: |
| 631 | # |
| 632 | # * `allUsers`: A special identifier that represents anyone who is |
| 633 | # on the internet; with or without a Google account. |
| 634 | # |
| 635 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 636 | # who is authenticated with a Google account or a service account. |
| 637 | # |
| 638 | # * `user:{emailid}`: An email address that represents a specific Google |
| 639 | # account. For example, `alice@example.com` . |
| 640 | # |
| 641 | # |
| 642 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 643 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 644 | # |
| 645 | # * `group:{emailid}`: An email address that represents a Google group. |
| 646 | # For example, `admins@example.com`. |
| 647 | # |
| 648 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 649 | # identifier) representing a user that has been recently deleted. For |
| 650 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 651 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 652 | # retains the role in the binding. |
| 653 | # |
| 654 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 655 | # unique identifier) representing a service account that has been recently |
| 656 | # deleted. For example, |
| 657 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 658 | # If the service account is undeleted, this value reverts to |
| 659 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 660 | # role in the binding. |
| 661 | # |
| 662 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 663 | # identifier) representing a Google group that has been recently |
| 664 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 665 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 666 | # recovered group retains the role in the binding. |
| 667 | # |
| 668 | # |
| 669 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 670 | # users of that domain. For example, `google.com` or `example.com`. |
| 671 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 673 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 674 | }, |
| 675 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | }</pre> |
| 677 | </div> |
| 678 | |
| 679 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 680 | <code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 681 | <pre>Lists Data Fusion instances in the specified project and location. |
| 682 | |
| 683 | Args: |
| 684 | parent: string, The project and location for which to retrieve instance information |
| 685 | in the format projects/{project}/locations/{location}. If the location is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | specified as '-' (wildcard), then all regions available to the project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 687 | are queried, and the results are aggregated. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 688 | pageToken: string, The next_page_token value to use if there are additional |
| 689 | results to retrieve for this list request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 690 | orderBy: string, Sort results. Supported values are "name", "name desc", or "" (unsorted). |
| 691 | pageSize: integer, The maximum number of items to return. |
| 692 | filter: string, List filter. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 693 | x__xgafv: string, V1 error format. |
| 694 | Allowed values |
| 695 | 1 - v1 error format |
| 696 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 697 | |
| 698 | Returns: |
| 699 | An object of the form: |
| 700 | |
| 701 | { # Response message for the list instance request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 702 | "unreachable": [ # Locations that could not be reached. |
| 703 | "A String", |
| 704 | ], |
| 705 | "instances": [ # Represents a list of Data Fusion instances. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 706 | { # Represents a Data Fusion instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 707 | # Next available ID: 23 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 708 | "availableVersion": [ # Available versions that the instance can be upgraded to using |
| 709 | # UpdateInstanceRequest. |
| 710 | { # The Data Fusion version. |
| 711 | "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 712 | }, |
| 713 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 714 | "displayName": "A String", # Display name for an instance. |
| 715 | "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. |
| 716 | "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. |
| 717 | "createTime": "A String", # Output only. The time the instance was created. |
| 718 | "labels": { # The resource labels for instance to use to annotate any related underlying |
| 719 | # resources such as Compute Engine VMs. The character '=' is not allowed to |
| 720 | # be used within the labels. |
| 721 | "a_key": "A String", |
| 722 | }, |
| 723 | "updateTime": "A String", # Output only. The time the instance was last updated. |
| 724 | "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. |
| 725 | "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. |
| 726 | "type": "A String", # Required. Instance type. |
| 727 | "version": "A String", # Current version of Data Fusion. |
| 728 | "stateMessage": "A String", # Output only. Additional information about the current state of this Data |
| 729 | # Fusion instance if available. |
| 730 | "accelerators": [ # List of accelerators enabled for this CDF instance. |
| 731 | { # Identifies Data Fusion accelerators for an instance. |
| 732 | "acceleratorType": "A String", # The type of an accelator for a CDF instance. |
| 733 | }, |
| 734 | ], |
| 735 | "description": "A String", # Optional. An optional description of this instance. |
| 736 | "options": { # Map of additional options used to configure the behavior of |
| 737 | # Data Fusion instance. |
| 738 | "a_key": "A String", |
| 739 | }, |
| 740 | "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 741 | # Fusion instance is to be created. |
| 742 | # are used for peering with the customer network. Configurations are optional |
| 743 | # when a public Data Fusion instance is to be created. However, providing |
| 744 | # these configurations allows several benefits, such as reduced network latency |
| 745 | # while accessing the customer resources from managed Data Fusion instance |
| 746 | # nodes, as well as access to the customer on-prem resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 747 | "network": "A String", # Name of the network in the customer project with which the Tenant Project |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 748 | # will be peered for executing pipelines. In case of shared VPC where the |
| 749 | # network resides in another host project the network should specified in |
| 750 | # the form of projects/{host-project-id}/global/networks/{network} |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 751 | "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 752 | # nodes. This range must not overlap with any other ranges used in the Data |
| 753 | # Fusion instance network. |
| 754 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 755 | "state": "A String", # Output only. The current state of this Data Fusion instance. |
| 756 | "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. |
| 757 | "name": "A String", # Output only. The name of this instance is in the form of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 758 | # projects/{project}/locations/{location}/instances/{instance}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 759 | "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. |
| 760 | "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to |
| 761 | # true, all Data Fusion nodes will have private IP addresses and will not be |
| 762 | # able to access the public internet. |
| 763 | "serviceAccount": "A String", # Output only. Service account which will be used to access resources in |
| 764 | # the customer project." |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 765 | }, |
| 766 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 767 | "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more |
| 768 | # results in the list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 769 | }</pre> |
| 770 | </div> |
| 771 | |
| 772 | <div class="method"> |
| 773 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 774 | <pre>Retrieves the next page of results. |
| 775 | |
| 776 | Args: |
| 777 | previous_request: The request for the previous page. (required) |
| 778 | previous_response: The response from the request for the previous page. (required) |
| 779 | |
| 780 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 781 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 782 | page. Returns None if there are no more items in the collection. |
| 783 | </pre> |
| 784 | </div> |
| 785 | |
| 786 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 787 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 788 | <pre>Updates a single Data Fusion instance. |
| 789 | |
| 790 | Args: |
| 791 | name: string, Output only. The name of this instance is in the form of |
| 792 | projects/{project}/locations/{location}/instances/{instance}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 793 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 794 | The object takes the form of: |
| 795 | |
| 796 | { # Represents a Data Fusion instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 797 | # Next available ID: 23 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 798 | "availableVersion": [ # Available versions that the instance can be upgraded to using |
| 799 | # UpdateInstanceRequest. |
| 800 | { # The Data Fusion version. |
| 801 | "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 802 | }, |
| 803 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 804 | "displayName": "A String", # Display name for an instance. |
| 805 | "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. |
| 806 | "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. |
| 807 | "createTime": "A String", # Output only. The time the instance was created. |
| 808 | "labels": { # The resource labels for instance to use to annotate any related underlying |
| 809 | # resources such as Compute Engine VMs. The character '=' is not allowed to |
| 810 | # be used within the labels. |
| 811 | "a_key": "A String", |
| 812 | }, |
| 813 | "updateTime": "A String", # Output only. The time the instance was last updated. |
| 814 | "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. |
| 815 | "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. |
| 816 | "type": "A String", # Required. Instance type. |
| 817 | "version": "A String", # Current version of Data Fusion. |
| 818 | "stateMessage": "A String", # Output only. Additional information about the current state of this Data |
| 819 | # Fusion instance if available. |
| 820 | "accelerators": [ # List of accelerators enabled for this CDF instance. |
| 821 | { # Identifies Data Fusion accelerators for an instance. |
| 822 | "acceleratorType": "A String", # The type of an accelator for a CDF instance. |
| 823 | }, |
| 824 | ], |
| 825 | "description": "A String", # Optional. An optional description of this instance. |
| 826 | "options": { # Map of additional options used to configure the behavior of |
| 827 | # Data Fusion instance. |
| 828 | "a_key": "A String", |
| 829 | }, |
| 830 | "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 831 | # Fusion instance is to be created. |
| 832 | # are used for peering with the customer network. Configurations are optional |
| 833 | # when a public Data Fusion instance is to be created. However, providing |
| 834 | # these configurations allows several benefits, such as reduced network latency |
| 835 | # while accessing the customer resources from managed Data Fusion instance |
| 836 | # nodes, as well as access to the customer on-prem resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 837 | "network": "A String", # Name of the network in the customer project with which the Tenant Project |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 838 | # will be peered for executing pipelines. In case of shared VPC where the |
| 839 | # network resides in another host project the network should specified in |
| 840 | # the form of projects/{host-project-id}/global/networks/{network} |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 841 | "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 842 | # nodes. This range must not overlap with any other ranges used in the Data |
| 843 | # Fusion instance network. |
| 844 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 845 | "state": "A String", # Output only. The current state of this Data Fusion instance. |
| 846 | "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. |
| 847 | "name": "A String", # Output only. The name of this instance is in the form of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 848 | # projects/{project}/locations/{location}/instances/{instance}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 849 | "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. |
| 850 | "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to |
| 851 | # true, all Data Fusion nodes will have private IP addresses and will not be |
| 852 | # able to access the public internet. |
| 853 | "serviceAccount": "A String", # Output only. Service account which will be used to access resources in |
| 854 | # the customer project." |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 855 | } |
| 856 | |
| 857 | updateMask: string, Field mask is used to specify the fields that the update will overwrite |
| 858 | in an instance resource. The fields specified in the update_mask are |
| 859 | relative to the resource, not the full request. |
| 860 | A field will be overwritten if it is in the mask. |
| 861 | If the user does not provide a mask, all the supported fields (labels and |
| 862 | options currently) will be overwritten. |
| 863 | x__xgafv: string, V1 error format. |
| 864 | Allowed values |
| 865 | 1 - v1 error format |
| 866 | 2 - v2 error format |
| 867 | |
| 868 | Returns: |
| 869 | An object of the form: |
| 870 | |
| 871 | { # This resource represents a long-running operation that is the result of a |
| 872 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 873 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 874 | # method returns no data on success, such as `Delete`, the response is |
| 875 | # `google.protobuf.Empty`. If the original method is standard |
| 876 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 877 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 878 | # is the original method name. For example, if the original method name |
| 879 | # is `TakeSnapshot()`, the inferred response type is |
| 880 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 881 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 882 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 883 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 884 | # originally returns it. If you use the default HTTP mapping, the |
| 885 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 886 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 887 | # different programming environments, including REST APIs and RPC APIs. It is |
| 888 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 889 | # three pieces of data: error code, error message, and error details. |
| 890 | # |
| 891 | # You can find out more about this error model and how to work with it in the |
| 892 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 893 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 894 | # message types for APIs to use. |
| 895 | { |
| 896 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 897 | }, |
| 898 | ], |
| 899 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 900 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 901 | # user-facing error message should be localized and sent in the |
| 902 | # google.rpc.Status.details field, or localized by the client. |
| 903 | }, |
| 904 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 905 | # contains progress information and common metadata such as create time. |
| 906 | # Some services might not provide such metadata. Any method that returns a |
| 907 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 908 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 909 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 911 | # If `true`, the operation is completed, and either `error` or `response` is |
| 912 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 913 | }</pre> |
| 914 | </div> |
| 915 | |
| 916 | <div class="method"> |
| 917 | <code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code> |
| 918 | <pre>Restart a single Data Fusion instance. |
| 919 | At the end of an operation instance is fully restarted. |
| 920 | |
| 921 | Args: |
| 922 | name: string, Name of the Data Fusion instance which need to be restarted in the form of |
| 923 | projects/{project}/locations/{location}/instances/{instance} (required) |
| 924 | body: object, The request body. |
| 925 | The object takes the form of: |
| 926 | |
| 927 | { # Request message for restarting a Data Fusion instance. |
| 928 | } |
| 929 | |
| 930 | x__xgafv: string, V1 error format. |
| 931 | Allowed values |
| 932 | 1 - v1 error format |
| 933 | 2 - v2 error format |
| 934 | |
| 935 | Returns: |
| 936 | An object of the form: |
| 937 | |
| 938 | { # This resource represents a long-running operation that is the result of a |
| 939 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 941 | # method returns no data on success, such as `Delete`, the response is |
| 942 | # `google.protobuf.Empty`. If the original method is standard |
| 943 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 944 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 945 | # is the original method name. For example, if the original method name |
| 946 | # is `TakeSnapshot()`, the inferred response type is |
| 947 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 948 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 949 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 950 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 951 | # originally returns it. If you use the default HTTP mapping, the |
| 952 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 953 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 954 | # different programming environments, including REST APIs and RPC APIs. It is |
| 955 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 956 | # three pieces of data: error code, error message, and error details. |
| 957 | # |
| 958 | # You can find out more about this error model and how to work with it in the |
| 959 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 960 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 961 | # message types for APIs to use. |
| 962 | { |
| 963 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 964 | }, |
| 965 | ], |
| 966 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 967 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 968 | # user-facing error message should be localized and sent in the |
| 969 | # google.rpc.Status.details field, or localized by the client. |
| 970 | }, |
| 971 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 972 | # contains progress information and common metadata such as create time. |
| 973 | # Some services might not provide such metadata. Any method that returns a |
| 974 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 975 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 976 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 977 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 978 | # If `true`, the operation is completed, and either `error` or `response` is |
| 979 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 980 | }</pre> |
| 981 | </div> |
| 982 | |
| 983 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 984 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 985 | <pre>Sets the access control policy on the specified resource. Replaces any |
| 986 | existing policy. |
| 987 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 988 | Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED |
| 989 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 990 | Args: |
| 991 | resource: string, REQUIRED: The resource for which the policy is being specified. |
| 992 | See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 993 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 994 | The object takes the form of: |
| 995 | |
| 996 | { # Request message for `SetIamPolicy` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 997 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 998 | # the policy is limited to a few 10s of KB. An empty policy is a |
| 999 | # valid policy but certain Cloud Platform services (such as Projects) |
| 1000 | # might reject them. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1001 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1002 | # |
| 1003 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1004 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 1005 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 1006 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 1007 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 1008 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1009 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1010 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 1011 | # expression that allows access to a resource only if the expression evaluates |
| 1012 | # to `true`. A condition can add constraints based on attributes of the |
| 1013 | # request, the resource, or both. |
| 1014 | # |
| 1015 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1016 | # |
| 1017 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1018 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1019 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1020 | # "role": "roles/resourcemanager.organizationAdmin", |
| 1021 | # "members": [ |
| 1022 | # "user:mike@example.com", |
| 1023 | # "group:admins@example.com", |
| 1024 | # "domain:google.com", |
| 1025 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1026 | # ] |
| 1027 | # }, |
| 1028 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1029 | # "role": "roles/resourcemanager.organizationViewer", |
| 1030 | # "members": ["user:eve@example.com"], |
| 1031 | # "condition": { |
| 1032 | # "title": "expirable access", |
| 1033 | # "description": "Does not grant access after Sep 2020", |
| 1034 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1035 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1036 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1037 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1038 | # "etag": "BwWWja0YfJA=", |
| 1039 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1040 | # } |
| 1041 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1042 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1043 | # |
| 1044 | # bindings: |
| 1045 | # - members: |
| 1046 | # - user:mike@example.com |
| 1047 | # - group:admins@example.com |
| 1048 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1049 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 1050 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1051 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1052 | # - user:eve@example.com |
| 1053 | # role: roles/resourcemanager.organizationViewer |
| 1054 | # condition: |
| 1055 | # title: expirable access |
| 1056 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1057 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1058 | # - etag: BwWWja0YfJA= |
| 1059 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1060 | # |
| 1061 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1062 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1063 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 1064 | # prevent simultaneous updates of a policy from overwriting each other. |
| 1065 | # It is strongly suggested that systems make use of the `etag` in the |
| 1066 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 1067 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 1068 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 1069 | # ensure that their change will be applied to the same version of the policy. |
| 1070 | # |
| 1071 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1072 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1073 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1074 | # the conditions in the version `3` policy are lost. |
| 1075 | "version": 42, # Specifies the format of the policy. |
| 1076 | # |
| 1077 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 1078 | # are rejected. |
| 1079 | # |
| 1080 | # Any operation that affects conditional role bindings must specify version |
| 1081 | # `3`. This requirement applies to the following operations: |
| 1082 | # |
| 1083 | # * Getting a policy that includes a conditional role binding |
| 1084 | # * Adding a conditional role binding to a policy |
| 1085 | # * Changing a conditional role binding in a policy |
| 1086 | # * Removing any role binding, with or without a condition, from a policy |
| 1087 | # that includes conditions |
| 1088 | # |
| 1089 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1090 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1091 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1092 | # the conditions in the version `3` policy are lost. |
| 1093 | # |
| 1094 | # If a policy does not include any conditions, operations on that policy may |
| 1095 | # specify any valid version or leave the field unset. |
| 1096 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1097 | { # Specifies the audit configuration for a service. |
| 1098 | # The configuration determines which permission types are logged, and what |
| 1099 | # identities, if any, are exempted from logging. |
| 1100 | # An AuditConfig must have one or more AuditLogConfigs. |
| 1101 | # |
| 1102 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 1103 | # the union of the two AuditConfigs is used for that service: the log_types |
| 1104 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 1105 | # AuditLogConfig are exempted. |
| 1106 | # |
| 1107 | # Example Policy with multiple AuditConfigs: |
| 1108 | # |
| 1109 | # { |
| 1110 | # "audit_configs": [ |
| 1111 | # { |
| 1112 | # "service": "allServices" |
| 1113 | # "audit_log_configs": [ |
| 1114 | # { |
| 1115 | # "log_type": "DATA_READ", |
| 1116 | # "exempted_members": [ |
| 1117 | # "user:jose@example.com" |
| 1118 | # ] |
| 1119 | # }, |
| 1120 | # { |
| 1121 | # "log_type": "DATA_WRITE", |
| 1122 | # }, |
| 1123 | # { |
| 1124 | # "log_type": "ADMIN_READ", |
| 1125 | # } |
| 1126 | # ] |
| 1127 | # }, |
| 1128 | # { |
| 1129 | # "service": "sampleservice.googleapis.com" |
| 1130 | # "audit_log_configs": [ |
| 1131 | # { |
| 1132 | # "log_type": "DATA_READ", |
| 1133 | # }, |
| 1134 | # { |
| 1135 | # "log_type": "DATA_WRITE", |
| 1136 | # "exempted_members": [ |
| 1137 | # "user:aliya@example.com" |
| 1138 | # ] |
| 1139 | # } |
| 1140 | # ] |
| 1141 | # } |
| 1142 | # ] |
| 1143 | # } |
| 1144 | # |
| 1145 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 1146 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 1147 | # aliya@example.com from DATA_WRITE logging. |
| 1148 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 1149 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 1150 | # `allServices` is a special value that covers all services. |
| 1151 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1152 | { # Provides the configuration for logging a type of permissions. |
| 1153 | # Example: |
| 1154 | # |
| 1155 | # { |
| 1156 | # "audit_log_configs": [ |
| 1157 | # { |
| 1158 | # "log_type": "DATA_READ", |
| 1159 | # "exempted_members": [ |
| 1160 | # "user:jose@example.com" |
| 1161 | # ] |
| 1162 | # }, |
| 1163 | # { |
| 1164 | # "log_type": "DATA_WRITE", |
| 1165 | # } |
| 1166 | # ] |
| 1167 | # } |
| 1168 | # |
| 1169 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 1170 | # jose@example.com from DATA_READ logging. |
| 1171 | "logType": "A String", # The log type that this config enables. |
| 1172 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 1173 | # permission. |
| 1174 | # Follows the same format of Binding.members. |
| 1175 | "A String", |
| 1176 | ], |
| 1177 | }, |
| 1178 | ], |
| 1179 | }, |
| 1180 | ], |
| 1181 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1182 | # `condition` that determines how and when the `bindings` are applied. Each |
| 1183 | # of the `bindings` must contain at least one member. |
| 1184 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1185 | "role": "A String", # Role that is assigned to `members`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1186 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1187 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1188 | # NOTE: An unsatisfied condition will not allow user access via current |
| 1189 | # binding. Different bindings, including their conditions, are examined |
| 1190 | # independently. |
| 1191 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1192 | # are documented at https://github.com/google/cel-spec. |
| 1193 | # |
| 1194 | # Example (Comparison): |
| 1195 | # |
| 1196 | # title: "Summary size limit" |
| 1197 | # description: "Determines if a summary is less than 100 chars" |
| 1198 | # expression: "document.summary.size() < 100" |
| 1199 | # |
| 1200 | # Example (Equality): |
| 1201 | # |
| 1202 | # title: "Requestor is owner" |
| 1203 | # description: "Determines if requestor is the document owner" |
| 1204 | # expression: "document.owner == request.auth.claims.email" |
| 1205 | # |
| 1206 | # Example (Logic): |
| 1207 | # |
| 1208 | # title: "Public documents" |
| 1209 | # description: "Determine whether the document should be publicly visible" |
| 1210 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1211 | # |
| 1212 | # Example (Data Manipulation): |
| 1213 | # |
| 1214 | # title: "Notification string" |
| 1215 | # description: "Create a notification string with a timestamp." |
| 1216 | # expression: "'New message received at ' + string(document.create_time)" |
| 1217 | # |
| 1218 | # The exact variables and functions that may be referenced within an expression |
| 1219 | # are determined by the service that evaluates it. See the service |
| 1220 | # documentation for additional information. |
| 1221 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1222 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1223 | # expression. |
| 1224 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1225 | # reporting, e.g. a file name and a position in the file. |
| 1226 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1227 | # describes the expression, e.g. when hovered over it in a UI. |
| 1228 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1229 | # syntax. |
| 1230 | }, |
| 1231 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1232 | # `members` can have the following values: |
| 1233 | # |
| 1234 | # * `allUsers`: A special identifier that represents anyone who is |
| 1235 | # on the internet; with or without a Google account. |
| 1236 | # |
| 1237 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1238 | # who is authenticated with a Google account or a service account. |
| 1239 | # |
| 1240 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1241 | # account. For example, `alice@example.com` . |
| 1242 | # |
| 1243 | # |
| 1244 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1245 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1246 | # |
| 1247 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1248 | # For example, `admins@example.com`. |
| 1249 | # |
| 1250 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1251 | # identifier) representing a user that has been recently deleted. For |
| 1252 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1253 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1254 | # retains the role in the binding. |
| 1255 | # |
| 1256 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1257 | # unique identifier) representing a service account that has been recently |
| 1258 | # deleted. For example, |
| 1259 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1260 | # If the service account is undeleted, this value reverts to |
| 1261 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1262 | # role in the binding. |
| 1263 | # |
| 1264 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1265 | # identifier) representing a Google group that has been recently |
| 1266 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1267 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1268 | # recovered group retains the role in the binding. |
| 1269 | # |
| 1270 | # |
| 1271 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1272 | # users of that domain. For example, `google.com` or `example.com`. |
| 1273 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1274 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1275 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1276 | }, |
| 1277 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1278 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1279 | "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1280 | # the fields in the mask will be modified. If no mask is provided, the |
| 1281 | # following default mask is used: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1282 | # paths: "bindings, etag" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1283 | # This field is only used by Cloud IAM. |
| 1284 | } |
| 1285 | |
| 1286 | x__xgafv: string, V1 error format. |
| 1287 | Allowed values |
| 1288 | 1 - v1 error format |
| 1289 | 2 - v2 error format |
| 1290 | |
| 1291 | Returns: |
| 1292 | An object of the form: |
| 1293 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1294 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 1295 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1296 | # |
| 1297 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1298 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 1299 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 1300 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 1301 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 1302 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1303 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1304 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 1305 | # expression that allows access to a resource only if the expression evaluates |
| 1306 | # to `true`. A condition can add constraints based on attributes of the |
| 1307 | # request, the resource, or both. |
| 1308 | # |
| 1309 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1310 | # |
| 1311 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1312 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1313 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1314 | # "role": "roles/resourcemanager.organizationAdmin", |
| 1315 | # "members": [ |
| 1316 | # "user:mike@example.com", |
| 1317 | # "group:admins@example.com", |
| 1318 | # "domain:google.com", |
| 1319 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1320 | # ] |
| 1321 | # }, |
| 1322 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1323 | # "role": "roles/resourcemanager.organizationViewer", |
| 1324 | # "members": ["user:eve@example.com"], |
| 1325 | # "condition": { |
| 1326 | # "title": "expirable access", |
| 1327 | # "description": "Does not grant access after Sep 2020", |
| 1328 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1329 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1330 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1331 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1332 | # "etag": "BwWWja0YfJA=", |
| 1333 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1334 | # } |
| 1335 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1336 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1337 | # |
| 1338 | # bindings: |
| 1339 | # - members: |
| 1340 | # - user:mike@example.com |
| 1341 | # - group:admins@example.com |
| 1342 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1343 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 1344 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1345 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1346 | # - user:eve@example.com |
| 1347 | # role: roles/resourcemanager.organizationViewer |
| 1348 | # condition: |
| 1349 | # title: expirable access |
| 1350 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1351 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1352 | # - etag: BwWWja0YfJA= |
| 1353 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1354 | # |
| 1355 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1356 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1357 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 1358 | # prevent simultaneous updates of a policy from overwriting each other. |
| 1359 | # It is strongly suggested that systems make use of the `etag` in the |
| 1360 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 1361 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 1362 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 1363 | # ensure that their change will be applied to the same version of the policy. |
| 1364 | # |
| 1365 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1366 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1367 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1368 | # the conditions in the version `3` policy are lost. |
| 1369 | "version": 42, # Specifies the format of the policy. |
| 1370 | # |
| 1371 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 1372 | # are rejected. |
| 1373 | # |
| 1374 | # Any operation that affects conditional role bindings must specify version |
| 1375 | # `3`. This requirement applies to the following operations: |
| 1376 | # |
| 1377 | # * Getting a policy that includes a conditional role binding |
| 1378 | # * Adding a conditional role binding to a policy |
| 1379 | # * Changing a conditional role binding in a policy |
| 1380 | # * Removing any role binding, with or without a condition, from a policy |
| 1381 | # that includes conditions |
| 1382 | # |
| 1383 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1384 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1385 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1386 | # the conditions in the version `3` policy are lost. |
| 1387 | # |
| 1388 | # If a policy does not include any conditions, operations on that policy may |
| 1389 | # specify any valid version or leave the field unset. |
| 1390 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1391 | { # Specifies the audit configuration for a service. |
| 1392 | # The configuration determines which permission types are logged, and what |
| 1393 | # identities, if any, are exempted from logging. |
| 1394 | # An AuditConfig must have one or more AuditLogConfigs. |
| 1395 | # |
| 1396 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 1397 | # the union of the two AuditConfigs is used for that service: the log_types |
| 1398 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 1399 | # AuditLogConfig are exempted. |
| 1400 | # |
| 1401 | # Example Policy with multiple AuditConfigs: |
| 1402 | # |
| 1403 | # { |
| 1404 | # "audit_configs": [ |
| 1405 | # { |
| 1406 | # "service": "allServices" |
| 1407 | # "audit_log_configs": [ |
| 1408 | # { |
| 1409 | # "log_type": "DATA_READ", |
| 1410 | # "exempted_members": [ |
| 1411 | # "user:jose@example.com" |
| 1412 | # ] |
| 1413 | # }, |
| 1414 | # { |
| 1415 | # "log_type": "DATA_WRITE", |
| 1416 | # }, |
| 1417 | # { |
| 1418 | # "log_type": "ADMIN_READ", |
| 1419 | # } |
| 1420 | # ] |
| 1421 | # }, |
| 1422 | # { |
| 1423 | # "service": "sampleservice.googleapis.com" |
| 1424 | # "audit_log_configs": [ |
| 1425 | # { |
| 1426 | # "log_type": "DATA_READ", |
| 1427 | # }, |
| 1428 | # { |
| 1429 | # "log_type": "DATA_WRITE", |
| 1430 | # "exempted_members": [ |
| 1431 | # "user:aliya@example.com" |
| 1432 | # ] |
| 1433 | # } |
| 1434 | # ] |
| 1435 | # } |
| 1436 | # ] |
| 1437 | # } |
| 1438 | # |
| 1439 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 1440 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 1441 | # aliya@example.com from DATA_WRITE logging. |
| 1442 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 1443 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 1444 | # `allServices` is a special value that covers all services. |
| 1445 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1446 | { # Provides the configuration for logging a type of permissions. |
| 1447 | # Example: |
| 1448 | # |
| 1449 | # { |
| 1450 | # "audit_log_configs": [ |
| 1451 | # { |
| 1452 | # "log_type": "DATA_READ", |
| 1453 | # "exempted_members": [ |
| 1454 | # "user:jose@example.com" |
| 1455 | # ] |
| 1456 | # }, |
| 1457 | # { |
| 1458 | # "log_type": "DATA_WRITE", |
| 1459 | # } |
| 1460 | # ] |
| 1461 | # } |
| 1462 | # |
| 1463 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 1464 | # jose@example.com from DATA_READ logging. |
| 1465 | "logType": "A String", # The log type that this config enables. |
| 1466 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 1467 | # permission. |
| 1468 | # Follows the same format of Binding.members. |
| 1469 | "A String", |
| 1470 | ], |
| 1471 | }, |
| 1472 | ], |
| 1473 | }, |
| 1474 | ], |
| 1475 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1476 | # `condition` that determines how and when the `bindings` are applied. Each |
| 1477 | # of the `bindings` must contain at least one member. |
| 1478 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1479 | "role": "A String", # Role that is assigned to `members`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1480 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1481 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1482 | # NOTE: An unsatisfied condition will not allow user access via current |
| 1483 | # binding. Different bindings, including their conditions, are examined |
| 1484 | # independently. |
| 1485 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1486 | # are documented at https://github.com/google/cel-spec. |
| 1487 | # |
| 1488 | # Example (Comparison): |
| 1489 | # |
| 1490 | # title: "Summary size limit" |
| 1491 | # description: "Determines if a summary is less than 100 chars" |
| 1492 | # expression: "document.summary.size() < 100" |
| 1493 | # |
| 1494 | # Example (Equality): |
| 1495 | # |
| 1496 | # title: "Requestor is owner" |
| 1497 | # description: "Determines if requestor is the document owner" |
| 1498 | # expression: "document.owner == request.auth.claims.email" |
| 1499 | # |
| 1500 | # Example (Logic): |
| 1501 | # |
| 1502 | # title: "Public documents" |
| 1503 | # description: "Determine whether the document should be publicly visible" |
| 1504 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1505 | # |
| 1506 | # Example (Data Manipulation): |
| 1507 | # |
| 1508 | # title: "Notification string" |
| 1509 | # description: "Create a notification string with a timestamp." |
| 1510 | # expression: "'New message received at ' + string(document.create_time)" |
| 1511 | # |
| 1512 | # The exact variables and functions that may be referenced within an expression |
| 1513 | # are determined by the service that evaluates it. See the service |
| 1514 | # documentation for additional information. |
| 1515 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1516 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1517 | # expression. |
| 1518 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1519 | # reporting, e.g. a file name and a position in the file. |
| 1520 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1521 | # describes the expression, e.g. when hovered over it in a UI. |
| 1522 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1523 | # syntax. |
| 1524 | }, |
| 1525 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1526 | # `members` can have the following values: |
| 1527 | # |
| 1528 | # * `allUsers`: A special identifier that represents anyone who is |
| 1529 | # on the internet; with or without a Google account. |
| 1530 | # |
| 1531 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1532 | # who is authenticated with a Google account or a service account. |
| 1533 | # |
| 1534 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1535 | # account. For example, `alice@example.com` . |
| 1536 | # |
| 1537 | # |
| 1538 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1539 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1540 | # |
| 1541 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1542 | # For example, `admins@example.com`. |
| 1543 | # |
| 1544 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1545 | # identifier) representing a user that has been recently deleted. For |
| 1546 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1547 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1548 | # retains the role in the binding. |
| 1549 | # |
| 1550 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1551 | # unique identifier) representing a service account that has been recently |
| 1552 | # deleted. For example, |
| 1553 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1554 | # If the service account is undeleted, this value reverts to |
| 1555 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1556 | # role in the binding. |
| 1557 | # |
| 1558 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1559 | # identifier) representing a Google group that has been recently |
| 1560 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1561 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1562 | # recovered group retains the role in the binding. |
| 1563 | # |
| 1564 | # |
| 1565 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1566 | # users of that domain. For example, `google.com` or `example.com`. |
| 1567 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1568 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1569 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1570 | }, |
| 1571 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1572 | }</pre> |
| 1573 | </div> |
| 1574 | |
| 1575 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1576 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1577 | <pre>Returns permissions that a caller has on the specified resource. |
| 1578 | If the resource does not exist, this will return an empty set of |
| 1579 | permissions, not a NOT_FOUND error. |
| 1580 | |
| 1581 | Note: This operation is designed to be used for building permission-aware |
| 1582 | UIs and command-line tools, not for authorization checking. This operation |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1583 | may "fail open" without warning. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1584 | |
| 1585 | Args: |
| 1586 | resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| 1587 | See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1588 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1589 | The object takes the form of: |
| 1590 | |
| 1591 | { # Request message for `TestIamPermissions` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1592 | "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| 1593 | # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1594 | # information see |
| 1595 | # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1596 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1597 | ], |
| 1598 | } |
| 1599 | |
| 1600 | x__xgafv: string, V1 error format. |
| 1601 | Allowed values |
| 1602 | 1 - v1 error format |
| 1603 | 2 - v2 error format |
| 1604 | |
| 1605 | Returns: |
| 1606 | An object of the form: |
| 1607 | |
| 1608 | { # Response message for `TestIamPermissions` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1609 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1610 | # allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1611 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1612 | ], |
| 1613 | }</pre> |
| 1614 | </div> |
| 1615 | |
| 1616 | <div class="method"> |
| 1617 | <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code> |
| 1618 | <pre>Upgrade a single Data Fusion instance. |
| 1619 | At the end of an operation instance is fully upgraded. |
| 1620 | |
| 1621 | Args: |
| 1622 | name: string, Name of the Data Fusion instance which need to be upgraded in the form of |
| 1623 | projects/{project}/locations/{location}/instances/{instance} |
| 1624 | Instance will be upgraded with the latest stable version of the Data |
| 1625 | Fusion. (required) |
| 1626 | body: object, The request body. |
| 1627 | The object takes the form of: |
| 1628 | |
| 1629 | { # Request message for upgrading a Data Fusion instance. |
| 1630 | # To change the instance properties, instance update should be used. |
| 1631 | } |
| 1632 | |
| 1633 | x__xgafv: string, V1 error format. |
| 1634 | Allowed values |
| 1635 | 1 - v1 error format |
| 1636 | 2 - v2 error format |
| 1637 | |
| 1638 | Returns: |
| 1639 | An object of the form: |
| 1640 | |
| 1641 | { # This resource represents a long-running operation that is the result of a |
| 1642 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1643 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1644 | # method returns no data on success, such as `Delete`, the response is |
| 1645 | # `google.protobuf.Empty`. If the original method is standard |
| 1646 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1647 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1648 | # is the original method name. For example, if the original method name |
| 1649 | # is `TakeSnapshot()`, the inferred response type is |
| 1650 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1651 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1652 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1653 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1654 | # originally returns it. If you use the default HTTP mapping, the |
| 1655 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1656 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 1657 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1658 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1659 | # three pieces of data: error code, error message, and error details. |
| 1660 | # |
| 1661 | # You can find out more about this error model and how to work with it in the |
| 1662 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1663 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1664 | # message types for APIs to use. |
| 1665 | { |
| 1666 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1667 | }, |
| 1668 | ], |
| 1669 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1670 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1671 | # user-facing error message should be localized and sent in the |
| 1672 | # google.rpc.Status.details field, or localized by the client. |
| 1673 | }, |
| 1674 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1675 | # contains progress information and common metadata such as create time. |
| 1676 | # Some services might not provide such metadata. Any method that returns a |
| 1677 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1678 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1679 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1680 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 1681 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1682 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1683 | }</pre> |
| 1684 | </div> |
| 1685 | |
| 1686 | </body></html> |