cancel(name, body=None, x__xgafv=None)

Cancels the disk migration job.

Args:
name: string, Required. The name of the DiskMigrationJob. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for 'CancelDiskMigrationJob' request.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

close()

Close httplib2 connections.

create(parent, body=None, diskMigrationJobId=None, requestId=None, x__xgafv=None)

Creates a new disk migration job in a given Source.

Args:
parent: string, Required. The DiskMigrationJob's parent. (required)
body: object, The request body.
The object takes the form of:

{ # Describes the disk which will be migrated from the source environment. The source disk has to be unattached.
"awsSourceDiskDetails": { # Represents the source AWS Disk details. # Details of the unattached AWS source disk.
"diskType": "A String", # Optional. Output only. Disk type.
"sizeGib": "A String", # Output only. Size in GiB.
"tags": { # Optional. Output only. A map of AWS volume tags.
"a_key": "A String",
},
"volumeId": "A String", # Required. AWS volume ID.
},
"createTime": "A String", # Output only. The time the DiskMigrationJob resource was created.
"errors": [ # Output only. Provides details on the errors that led to the disk migration job's state in case of an 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).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
],
"name": "A String", # Output only. Identifier. The identifier of the DiskMigrationJob.
"state": "A String", # Output only. State of the DiskMigrationJob.
"steps": [ # Output only. The disk migration steps list representing its progress.
{ # DiskMigrationStep holds information about the disk migration step progress.
"copyingSourceDiskSnapshot": { # CopyingSourceDiskSnapshotStep contains specific step details. # Copying source disk snapshot step.
},
"creatingSourceDiskSnapshot": { # CreatingSourceDiskSnapshotStep contains specific step details. # Creating source disk snapshot step.
},
"endTime": "A String", # Output only. The time the step has ended.
"provisioningTargetDisk": { # ProvisioningTargetDiskStep contains specific step details. # Creating target disk step.
},
"startTime": "A String", # Output only. The time the step has started.
},
],
"targetDetails": { # Details of the target disk in Compute Engine. # Required. Details of the target Disk in Compute Engine.
"encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key.
"kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
},
"labels": { # Optional. A map of labels to associate with the disk.
"a_key": "A String",
},
"targetDisk": { # Compute Engine disk target details. # Required. The target disk.
"diskId": "A String", # Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 "disk1" is the resource ID for the disk.
"diskType": "A String", # Required. The disk type to use.
"replicaZones": [ # Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.
"A String",
],
"zone": "A String", # Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}
},
"targetProject": "A String", # Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}
},
"updateTime": "A String", # Output only. The last time the DiskMigrationJob resource was updated.
}

diskMigrationJobId: string, Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes a single DiskMigrationJob.

Args:
name: string, Required. The name of the DiskMigrationJob. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets details of a single DiskMigrationJob.

Args:
  name: string, Required. The name of the DiskMigrationJob. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes the disk which will be migrated from the source environment. The source disk has to be unattached.
  "awsSourceDiskDetails": { # Represents the source AWS Disk details. # Details of the unattached AWS source disk.
    "diskType": "A String", # Optional. Output only. Disk type.
    "sizeGib": "A String", # Output only. Size in GiB.
    "tags": { # Optional. Output only. A map of AWS volume tags.
      "a_key": "A String",
    },
    "volumeId": "A String", # Required. AWS volume ID.
  },
  "createTime": "A String", # Output only. The time the DiskMigrationJob resource was created.
  "errors": [ # Output only. Provides details on the errors that led to the disk migration job's state in case of an 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "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.
    },
  ],
  "name": "A String", # Output only. Identifier. The identifier of the DiskMigrationJob.
  "state": "A String", # Output only. State of the DiskMigrationJob.
  "steps": [ # Output only. The disk migration steps list representing its progress.
    { # DiskMigrationStep holds information about the disk migration step progress.
      "copyingSourceDiskSnapshot": { # CopyingSourceDiskSnapshotStep contains specific step details. # Copying source disk snapshot step.
      },
      "creatingSourceDiskSnapshot": { # CreatingSourceDiskSnapshotStep contains specific step details. # Creating source disk snapshot step.
      },
      "endTime": "A String", # Output only. The time the step has ended.
      "provisioningTargetDisk": { # ProvisioningTargetDiskStep contains specific step details. # Creating target disk step.
      },
      "startTime": "A String", # Output only. The time the step has started.
    },
  ],
  "targetDetails": { # Details of the target disk in Compute Engine. # Required. Details of the target Disk in Compute Engine.
    "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key.
      "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
    },
    "labels": { # Optional. A map of labels to associate with the disk.
      "a_key": "A String",
    },
    "targetDisk": { # Compute Engine disk target details. # Required. The target disk.
      "diskId": "A String", # Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 "disk1" is the resource ID for the disk.
      "diskType": "A String", # Required. The disk type to use.
      "replicaZones": [ # Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.
        "A String",
      ],
      "zone": "A String", # Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}
    },
    "targetProject": "A String", # Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}
  },
  "updateTime": "A String", # Output only. The last time the DiskMigrationJob resource was updated.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists DiskMigrationJobs in a given Source.

Args:
  parent: string, Required. The parent, which owns this collection of DiskMigrationJobs. (required)
  filter: string, Optional. The filter request (according to AIP-160).
  orderBy: string, Optional. Ordering of the result list.
  pageSize: integer, Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for 'ListDiskMigrationJobs' request.
  "diskMigrationJobs": [ # Output only. The list of the disk migration jobs.
    { # Describes the disk which will be migrated from the source environment. The source disk has to be unattached.
      "awsSourceDiskDetails": { # Represents the source AWS Disk details. # Details of the unattached AWS source disk.
        "diskType": "A String", # Optional. Output only. Disk type.
        "sizeGib": "A String", # Output only. Size in GiB.
        "tags": { # Optional. Output only. A map of AWS volume tags.
          "a_key": "A String",
        },
        "volumeId": "A String", # Required. AWS volume ID.
      },
      "createTime": "A String", # Output only. The time the DiskMigrationJob resource was created.
      "errors": [ # Output only. Provides details on the errors that led to the disk migration job's state in case of an 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).
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "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.
        },
      ],
      "name": "A String", # Output only. Identifier. The identifier of the DiskMigrationJob.
      "state": "A String", # Output only. State of the DiskMigrationJob.
      "steps": [ # Output only. The disk migration steps list representing its progress.
        { # DiskMigrationStep holds information about the disk migration step progress.
          "copyingSourceDiskSnapshot": { # CopyingSourceDiskSnapshotStep contains specific step details. # Copying source disk snapshot step.
          },
          "creatingSourceDiskSnapshot": { # CreatingSourceDiskSnapshotStep contains specific step details. # Creating source disk snapshot step.
          },
          "endTime": "A String", # Output only. The time the step has ended.
          "provisioningTargetDisk": { # ProvisioningTargetDiskStep contains specific step details. # Creating target disk step.
          },
          "startTime": "A String", # Output only. The time the step has started.
        },
      ],
      "targetDetails": { # Details of the target disk in Compute Engine. # Required. Details of the target Disk in Compute Engine.
        "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key.
          "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
        },
        "labels": { # Optional. A map of labels to associate with the disk.
          "a_key": "A String",
        },
        "targetDisk": { # Compute Engine disk target details. # Required. The target disk.
          "diskId": "A String", # Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 "disk1" is the resource ID for the disk.
          "diskType": "A String", # Required. The disk type to use.
          "replicaZones": [ # Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.
            "A String",
          ],
          "zone": "A String", # Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}
        },
        "targetProject": "A String", # Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}
      },
      "updateTime": "A String", # Output only. The last time the DiskMigrationJob resource was updated.
    },
  ],
  "nextPageToken": "A String", # Optional. Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # Output only. Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single DiskMigrationJob.

Args:
name: string, Output only. Identifier. The identifier of the DiskMigrationJob. (required)
body: object, The request body.
The object takes the form of:

{ # Describes the disk which will be migrated from the source environment. The source disk has to be unattached.
"awsSourceDiskDetails": { # Represents the source AWS Disk details. # Details of the unattached AWS source disk.
"diskType": "A String", # Optional. Output only. Disk type.
"sizeGib": "A String", # Output only. Size in GiB.
"tags": { # Optional. Output only. A map of AWS volume tags.
"a_key": "A String",
},
"volumeId": "A String", # Required. AWS volume ID.
},
"createTime": "A String", # Output only. The time the DiskMigrationJob resource was created.
"errors": [ # Output only. Provides details on the errors that led to the disk migration job's state in case of an 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).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
],
"name": "A String", # Output only. Identifier. The identifier of the DiskMigrationJob.
"state": "A String", # Output only. State of the DiskMigrationJob.
"steps": [ # Output only. The disk migration steps list representing its progress.
{ # DiskMigrationStep holds information about the disk migration step progress.
"copyingSourceDiskSnapshot": { # CopyingSourceDiskSnapshotStep contains specific step details. # Copying source disk snapshot step.
},
"creatingSourceDiskSnapshot": { # CreatingSourceDiskSnapshotStep contains specific step details. # Creating source disk snapshot step.
},
"endTime": "A String", # Output only. The time the step has ended.
"provisioningTargetDisk": { # ProvisioningTargetDiskStep contains specific step details. # Creating target disk step.
},
"startTime": "A String", # Output only. The time the step has started.
},
],
"targetDetails": { # Details of the target disk in Compute Engine. # Required. Details of the target Disk in Compute Engine.
"encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. If the DiskMigrationJob parent Source resource has an encryption, this field must be set to the same encryption key.
"kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
},
"labels": { # Optional. A map of labels to associate with the disk.
"a_key": "A String",
},
"targetDisk": { # Compute Engine disk target details. # Required. The target disk.
"diskId": "A String", # Optional. Target Compute Engine Disk ID. This is the resource ID segment of the Compute Engine Disk to create. In the resource name compute/v1/projects/{project}/zones/{zone}/disks/disk1 "disk1" is the resource ID for the disk.
"diskType": "A String", # Required. The disk type to use.
"replicaZones": [ # Optional. Replication zones of the regional disk. Should be of the form: projects/{target-project}/locations/{replica-zone} Currently only one replica zone is supported.
"A String",
],
"zone": "A String", # Required. The Compute Engine zone in which to create the disk. Should be of the form: projects/{target-project}/locations/{zone}
},
"targetProject": "A String", # Required. The name of the resource of type TargetProject which represents the Compute Engine project in which to create the disk. Should be of the form: projects/{project}/locations/global/targetProjects/{target-project}
},
"updateTime": "A String", # Output only. The last time the DiskMigrationJob resource was updated.
}

requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the DiskMigrationJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, then a mask equivalent to all fields that are populated (have a non-empty value), will be implied.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

run(name, body=None, x__xgafv=None)

Runs the disk migration job.

Args:
name: string, Required. The name of the DiskMigrationJob. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for 'RunDiskMigrationJobRequest' request.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

VM Migration API . projects . locations . sources . diskMigrationJobs

Instance Methods

Method Details