1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="datamigration_v1.html">Database Migration API</a> . <a href="datamigration_v1.projects.html">projects</a> . <a href="datamigration_v1.projects.locations.html">locations</a> . <a href="datamigration_v1.projects.locations.migrationJobs.html">migrationJobs</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, migrationJobId=None, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new migration job in a given project and location.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a single migration job.</p> 86<p class="toc_element"> 87 <code><a href="#generateSshScript">generateSshScript(migrationJob, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Generate a SSH configuration script to configure the reverse SSH connectivity.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets details of a single migration job.</p> 92<p class="toc_element"> 93 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists migration jobs in a given project and location.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates the parameters of a single migration job.</p> 104<p class="toc_element"> 105 <code><a href="#promote">promote(name, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.</p> 107<p class="toc_element"> 108 <code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.</p> 110<p class="toc_element"> 111 <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).</p> 113<p class="toc_element"> 114 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p> 116<p class="toc_element"> 117 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Start an already created migration job.</p> 119<p class="toc_element"> 120 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Stops a running migration job.</p> 122<p class="toc_element"> 123 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p> 125<p class="toc_element"> 126 <code><a href="#verify">verify(name, body=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.</p> 128<h3>Method Details</h3> 129<div class="method"> 130 <code class="details" id="close">close()</code> 131 <pre>Close httplib2 connections.</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="create">create(parent, body=None, migrationJobId=None, requestId=None, x__xgafv=None)</code> 136 <pre>Creates a new migration job in a given project and location. 137 138Args: 139 parent: string, Required. The parent, which owns this collection of migration jobs. (required) 140 body: object, The request body. 141 The object takes the form of: 142 143{ # Represents a Database Migration Service migration job object. 144 "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 145 "destination": "A String", # Required. The resource name (URI) of the destination connection profile. 146 "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. 147 "engine": "A String", # The database engine. 148 "provider": "A String", # The database provider. 149 }, 150 "displayName": "A String", # The migration job display name. 151 "dumpPath": "A String", # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 152 "duration": "A String", # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". 153 "endTime": "A String", # Output only. If the migration job is completed, the time when it was completed. 154 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED. 155 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 156 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 157 { 158 "a_key": "", # Properties of the object. Contains field @type with type URL. 159 }, 160 ], 161 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 162 }, 163 "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 164 "a_key": "A String", 165 }, 166 "name": "A String", # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. 167 "phase": "A String", # Output only. The current migration job phase. 168 "reverseSshConnectivity": { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity. 169 "vm": "A String", # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 170 "vmIp": "A String", # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 171 "vmPort": 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 172 "vpc": "A String", # The name of the VPC to peer with the Cloud SQL private network. 173 }, 174 "source": "A String", # Required. The resource name (URI) of the source connection profile. 175 "sourceDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the source. 176 "engine": "A String", # The database engine. 177 "provider": "A String", # The database provider. 178 }, 179 "state": "A String", # The current migration job state. 180 "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed). 181 }, 182 "type": "A String", # Required. The migration job type. 183 "updateTime": "A String", # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 184 "vpcPeeringConnectivity": { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in. 185 "vpc": "A String", # The name of the VPC network to peer with the Cloud SQL private network. 186 }, 187} 188 189 migrationJobId: string, Required. The ID of the instance to create. 190 requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # This resource represents a long-running operation that is the result of a network API call. 200 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 201 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 202 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 203 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 204 { 205 "a_key": "", # Properties of the object. Contains field @type with type URL. 206 }, 207 ], 208 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 209 }, 210 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 211 "a_key": "", # Properties of the object. Contains field @type with type URL. 212 }, 213 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 214 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 215 "a_key": "", # Properties of the object. Contains field @type with type URL. 216 }, 217}</pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> 222 <pre>Deletes a single migration job. 223 224Args: 225 name: string, Required. Name of the migration job resource to delete. (required) 226 force: boolean, The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted. 227 requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. 228 x__xgafv: string, V1 error format. 229 Allowed values 230 1 - v1 error format 231 2 - v2 error format 232 233Returns: 234 An object of the form: 235 236 { # This resource represents a long-running operation that is the result of a network API call. 237 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 238 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 239 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 240 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 241 { 242 "a_key": "", # Properties of the object. Contains field @type with type URL. 243 }, 244 ], 245 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 246 }, 247 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 248 "a_key": "", # Properties of the object. Contains field @type with type URL. 249 }, 250 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 251 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 252 "a_key": "", # Properties of the object. Contains field @type with type URL. 253 }, 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="generateSshScript">generateSshScript(migrationJob, body=None, x__xgafv=None)</code> 259 <pre>Generate a SSH configuration script to configure the reverse SSH connectivity. 260 261Args: 262 migrationJob: string, Name of the migration job resource to generate the SSH script. (required) 263 body: object, The request body. 264 The object takes the form of: 265 266{ # Request message for 'GenerateSshScript' request. 267 "vm": "A String", # Required. Bastion VM Instance name to use or to create. 268 "vmCreationConfig": { # VM creation configuration message # The VM creation configuration 269 "subnet": "A String", # The subnet name the vm needs to be created in. 270 "vmMachineType": "A String", # Required. VM instance machine type to create. 271 "vmZone": "A String", # The Google Cloud Platform zone to create the VM in. 272 }, 273 "vmPort": 42, # The port that will be open on the bastion host 274 "vmSelectionConfig": { # VM selection configuration message # The VM selection configuration 275 "vmZone": "A String", # Required. The Google Cloud Platform zone the VM is located. 276 }, 277} 278 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # Response message for 'GenerateSshScript' request. 288 "script": "A String", # The ssh configuration script. 289}</pre> 290</div> 291 292<div class="method"> 293 <code class="details" id="get">get(name, x__xgafv=None)</code> 294 <pre>Gets details of a single migration job. 295 296Args: 297 name: string, Required. Name of the migration job resource to get. (required) 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # Represents a Database Migration Service migration job object. 307 "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 308 "destination": "A String", # Required. The resource name (URI) of the destination connection profile. 309 "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. 310 "engine": "A String", # The database engine. 311 "provider": "A String", # The database provider. 312 }, 313 "displayName": "A String", # The migration job display name. 314 "dumpPath": "A String", # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 315 "duration": "A String", # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". 316 "endTime": "A String", # Output only. If the migration job is completed, the time when it was completed. 317 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED. 318 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 319 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 320 { 321 "a_key": "", # Properties of the object. Contains field @type with type URL. 322 }, 323 ], 324 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 325 }, 326 "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 327 "a_key": "A String", 328 }, 329 "name": "A String", # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. 330 "phase": "A String", # Output only. The current migration job phase. 331 "reverseSshConnectivity": { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity. 332 "vm": "A String", # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 333 "vmIp": "A String", # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 334 "vmPort": 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 335 "vpc": "A String", # The name of the VPC to peer with the Cloud SQL private network. 336 }, 337 "source": "A String", # Required. The resource name (URI) of the source connection profile. 338 "sourceDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the source. 339 "engine": "A String", # The database engine. 340 "provider": "A String", # The database provider. 341 }, 342 "state": "A String", # The current migration job state. 343 "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed). 344 }, 345 "type": "A String", # Required. The migration job type. 346 "updateTime": "A String", # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 347 "vpcPeeringConnectivity": { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in. 348 "vpc": "A String", # The name of the VPC network to peer with the Cloud SQL private network. 349 }, 350}</pre> 351</div> 352 353<div class="method"> 354 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 355 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 356 357Args: 358 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 359 options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 360 x__xgafv: string, V1 error format. 361 Allowed values 362 1 - v1 error format 363 2 - v2 error format 364 365Returns: 366 An object of the form: 367 368 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 369 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 370 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 371 "auditLogConfigs": [ # The configuration for logging of each type of permission. 372 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 373 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 374 "A String", 375 ], 376 "logType": "A String", # The log type that this config enables. 377 }, 378 ], 379 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 380 }, 381 ], 382 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 383 { # Associates `members`, or principals, with a `role`. 384 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 385 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 386 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 387 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 388 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 389 }, 390 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 391 "A String", 392 ], 393 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 394 }, 395 ], 396 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 397 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 398}</pre> 399</div> 400 401<div class="method"> 402 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 403 <pre>Lists migration jobs in a given project and location. 404 405Args: 406 parent: string, Required. The parent, which owns this collection of migrationJobs. (required) 407 filter: string, A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration jobs connecting through the specific SSH tunnel bastion. 408 orderBy: string, Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc". 409 pageSize: integer, The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. 410 pageToken: string, The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token. 411 x__xgafv: string, V1 error format. 412 Allowed values 413 1 - v1 error format 414 2 - v2 error format 415 416Returns: 417 An object of the form: 418 419 { # Response message for 'ListMigrationJobs' request. 420 "migrationJobs": [ # The list of migration jobs objects. 421 { # Represents a Database Migration Service migration job object. 422 "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 423 "destination": "A String", # Required. The resource name (URI) of the destination connection profile. 424 "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. 425 "engine": "A String", # The database engine. 426 "provider": "A String", # The database provider. 427 }, 428 "displayName": "A String", # The migration job display name. 429 "dumpPath": "A String", # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 430 "duration": "A String", # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". 431 "endTime": "A String", # Output only. If the migration job is completed, the time when it was completed. 432 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED. 433 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 434 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 435 { 436 "a_key": "", # Properties of the object. Contains field @type with type URL. 437 }, 438 ], 439 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 440 }, 441 "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 442 "a_key": "A String", 443 }, 444 "name": "A String", # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. 445 "phase": "A String", # Output only. The current migration job phase. 446 "reverseSshConnectivity": { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity. 447 "vm": "A String", # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 448 "vmIp": "A String", # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 449 "vmPort": 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 450 "vpc": "A String", # The name of the VPC to peer with the Cloud SQL private network. 451 }, 452 "source": "A String", # Required. The resource name (URI) of the source connection profile. 453 "sourceDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the source. 454 "engine": "A String", # The database engine. 455 "provider": "A String", # The database provider. 456 }, 457 "state": "A String", # The current migration job state. 458 "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed). 459 }, 460 "type": "A String", # Required. The migration job type. 461 "updateTime": "A String", # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 462 "vpcPeeringConnectivity": { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in. 463 "vpc": "A String", # The name of the VPC network to peer with the Cloud SQL private network. 464 }, 465 }, 466 ], 467 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 468 "unreachable": [ # Locations that could not be reached. 469 "A String", 470 ], 471}</pre> 472</div> 473 474<div class="method"> 475 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 476 <pre>Retrieves the next page of results. 477 478Args: 479 previous_request: The request for the previous page. (required) 480 previous_response: The response from the request for the previous page. (required) 481 482Returns: 483 A request object that you can call 'execute()' on to request the next 484 page. Returns None if there are no more items in the collection. 485 </pre> 486</div> 487 488<div class="method"> 489 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> 490 <pre>Updates the parameters of a single migration job. 491 492Args: 493 name: string, The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. (required) 494 body: object, The request body. 495 The object takes the form of: 496 497{ # Represents a Database Migration Service migration job object. 498 "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 499 "destination": "A String", # Required. The resource name (URI) of the destination connection profile. 500 "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. 501 "engine": "A String", # The database engine. 502 "provider": "A String", # The database provider. 503 }, 504 "displayName": "A String", # The migration job display name. 505 "dumpPath": "A String", # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). 506 "duration": "A String", # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". 507 "endTime": "A String", # Output only. If the migration job is completed, the time when it was completed. 508 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED. 509 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 510 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 511 { 512 "a_key": "", # Properties of the object. Contains field @type with type URL. 513 }, 514 ], 515 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 516 }, 517 "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. 518 "a_key": "A String", 519 }, 520 "name": "A String", # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. 521 "phase": "A String", # Output only. The current migration job phase. 522 "reverseSshConnectivity": { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity. 523 "vm": "A String", # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 524 "vmIp": "A String", # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 525 "vmPort": 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. 526 "vpc": "A String", # The name of the VPC to peer with the Cloud SQL private network. 527 }, 528 "source": "A String", # Required. The resource name (URI) of the source connection profile. 529 "sourceDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the source. 530 "engine": "A String", # The database engine. 531 "provider": "A String", # The database provider. 532 }, 533 "state": "A String", # The current migration job state. 534 "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed). 535 }, 536 "type": "A String", # Required. The migration job type. 537 "updateTime": "A String", # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". 538 "vpcPeeringConnectivity": { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in. 539 "vpc": "A String", # The name of the VPC network to peer with the Cloud SQL private network. 540 }, 541} 542 543 requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. 544 updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update. 545 x__xgafv: string, V1 error format. 546 Allowed values 547 1 - v1 error format 548 2 - v2 error format 549 550Returns: 551 An object of the form: 552 553 { # This resource represents a long-running operation that is the result of a network API call. 554 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 555 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 556 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 557 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 558 { 559 "a_key": "", # Properties of the object. Contains field @type with type URL. 560 }, 561 ], 562 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 563 }, 564 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 565 "a_key": "", # Properties of the object. Contains field @type with type URL. 566 }, 567 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 568 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 569 "a_key": "", # Properties of the object. Contains field @type with type URL. 570 }, 571}</pre> 572</div> 573 574<div class="method"> 575 <code class="details" id="promote">promote(name, body=None, x__xgafv=None)</code> 576 <pre>Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database. 577 578Args: 579 name: string, Name of the migration job resource to promote. (required) 580 body: object, The request body. 581 The object takes the form of: 582 583{ # Request message for 'PromoteMigrationJob' request. 584} 585 586 x__xgafv: string, V1 error format. 587 Allowed values 588 1 - v1 error format 589 2 - v2 error format 590 591Returns: 592 An object of the form: 593 594 { # This resource represents a long-running operation that is the result of a network API call. 595 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 596 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 597 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 598 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 599 { 600 "a_key": "", # Properties of the object. Contains field @type with type URL. 601 }, 602 ], 603 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 604 }, 605 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 606 "a_key": "", # Properties of the object. Contains field @type with type URL. 607 }, 608 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 609 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 610 "a_key": "", # Properties of the object. Contains field @type with type URL. 611 }, 612}</pre> 613</div> 614 615<div class="method"> 616 <code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code> 617 <pre>Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch. 618 619Args: 620 name: string, Name of the migration job resource to restart. (required) 621 body: object, The request body. 622 The object takes the form of: 623 624{ # Request message for 'RestartMigrationJob' request. 625} 626 627 x__xgafv: string, V1 error format. 628 Allowed values 629 1 - v1 error format 630 2 - v2 error format 631 632Returns: 633 An object of the form: 634 635 { # This resource represents a long-running operation that is the result of a network API call. 636 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 637 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 638 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 639 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 640 { 641 "a_key": "", # Properties of the object. Contains field @type with type URL. 642 }, 643 ], 644 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 645 }, 646 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 647 "a_key": "", # Properties of the object. Contains field @type with type URL. 648 }, 649 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 650 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 651 "a_key": "", # Properties of the object. Contains field @type with type URL. 652 }, 653}</pre> 654</div> 655 656<div class="method"> 657 <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code> 658 <pre>Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase). 659 660Args: 661 name: string, Name of the migration job resource to resume. (required) 662 body: object, The request body. 663 The object takes the form of: 664 665{ # Request message for 'ResumeMigrationJob' request. 666} 667 668 x__xgafv: string, V1 error format. 669 Allowed values 670 1 - v1 error format 671 2 - v2 error format 672 673Returns: 674 An object of the form: 675 676 { # This resource represents a long-running operation that is the result of a network API call. 677 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 678 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 679 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 680 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 681 { 682 "a_key": "", # Properties of the object. Contains field @type with type URL. 683 }, 684 ], 685 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 686 }, 687 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 688 "a_key": "", # Properties of the object. Contains field @type with type URL. 689 }, 690 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 691 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 692 "a_key": "", # Properties of the object. Contains field @type with type URL. 693 }, 694}</pre> 695</div> 696 697<div class="method"> 698 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 699 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. 700 701Args: 702 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 703 body: object, The request body. 704 The object takes the form of: 705 706{ # Request message for `SetIamPolicy` method. 707 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. 708 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 709 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 710 "auditLogConfigs": [ # The configuration for logging of each type of permission. 711 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 712 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 713 "A String", 714 ], 715 "logType": "A String", # The log type that this config enables. 716 }, 717 ], 718 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 719 }, 720 ], 721 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 722 { # Associates `members`, or principals, with a `role`. 723 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 724 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 725 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 726 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 727 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 728 }, 729 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 730 "A String", 731 ], 732 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 733 }, 734 ], 735 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 736 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 737 }, 738 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` 739} 740 741 x__xgafv: string, V1 error format. 742 Allowed values 743 1 - v1 error format 744 2 - v2 error format 745 746Returns: 747 An object of the form: 748 749 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 750 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 751 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 752 "auditLogConfigs": [ # The configuration for logging of each type of permission. 753 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 754 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 755 "A String", 756 ], 757 "logType": "A String", # The log type that this config enables. 758 }, 759 ], 760 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 761 }, 762 ], 763 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 764 { # Associates `members`, or principals, with a `role`. 765 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 766 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 767 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 768 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 769 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 770 }, 771 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 772 "A String", 773 ], 774 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 775 }, 776 ], 777 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 778 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 779}</pre> 780</div> 781 782<div class="method"> 783 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> 784 <pre>Start an already created migration job. 785 786Args: 787 name: string, Name of the migration job resource to start. (required) 788 body: object, The request body. 789 The object takes the form of: 790 791{ # Request message for 'StartMigrationJob' request. 792} 793 794 x__xgafv: string, V1 error format. 795 Allowed values 796 1 - v1 error format 797 2 - v2 error format 798 799Returns: 800 An object of the form: 801 802 { # This resource represents a long-running operation that is the result of a network API call. 803 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 804 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 805 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 806 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 807 { 808 "a_key": "", # Properties of the object. Contains field @type with type URL. 809 }, 810 ], 811 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 812 }, 813 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 814 "a_key": "", # Properties of the object. Contains field @type with type URL. 815 }, 816 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 817 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 818 "a_key": "", # Properties of the object. Contains field @type with type URL. 819 }, 820}</pre> 821</div> 822 823<div class="method"> 824 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 825 <pre>Stops a running migration job. 826 827Args: 828 name: string, Name of the migration job resource to stop. (required) 829 body: object, The request body. 830 The object takes the form of: 831 832{ # Request message for 'StopMigrationJob' request. 833} 834 835 x__xgafv: string, V1 error format. 836 Allowed values 837 1 - v1 error format 838 2 - v2 error format 839 840Returns: 841 An object of the form: 842 843 { # This resource represents a long-running operation that is the result of a network API call. 844 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 845 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 846 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 847 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 848 { 849 "a_key": "", # Properties of the object. Contains field @type with type URL. 850 }, 851 ], 852 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 853 }, 854 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 855 "a_key": "", # Properties of the object. Contains field @type with type URL. 856 }, 857 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 858 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 859 "a_key": "", # Properties of the object. Contains field @type with type URL. 860 }, 861}</pre> 862</div> 863 864<div class="method"> 865 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 866 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. 867 868Args: 869 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 870 body: object, The request body. 871 The object takes the form of: 872 873{ # Request message for `TestIamPermissions` method. 874 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 875 "A String", 876 ], 877} 878 879 x__xgafv: string, V1 error format. 880 Allowed values 881 1 - v1 error format 882 2 - v2 error format 883 884Returns: 885 An object of the form: 886 887 { # Response message for `TestIamPermissions` method. 888 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 889 "A String", 890 ], 891}</pre> 892</div> 893 894<div class="method"> 895 <code class="details" id="verify">verify(name, body=None, x__xgafv=None)</code> 896 <pre>Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met. 897 898Args: 899 name: string, Name of the migration job resource to verify. (required) 900 body: object, The request body. 901 The object takes the form of: 902 903{ # Request message for 'VerifyMigrationJob' request. 904} 905 906 x__xgafv: string, V1 error format. 907 Allowed values 908 1 - v1 error format 909 2 - v2 error format 910 911Returns: 912 An object of the form: 913 914 { # This resource represents a long-running operation that is the result of a network API call. 915 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 916 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 917 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 918 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 919 { 920 "a_key": "", # Properties of the object. Contains field @type with type URL. 921 }, 922 ], 923 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 924 }, 925 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 926 "a_key": "", # Properties of the object. Contains field @type with type URL. 927 }, 928 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 929 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 930 "a_key": "", # Properties of the object. Contains field @type with type URL. 931 }, 932}</pre> 933</div> 934 935</body></html>