VM Migration API . projects . locations . imageImports . imageImportJobs

Instance Methods

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

Initiates the cancellation of a running clone job.

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single ImageImportJob.

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

Lists ImageImportJobs in a given project.

list_next()

Retrieves the next page of results.

Method Details

cancel(name, body=None, x__xgafv=None)
Initiates the cancellation of a running clone job.

Args:
  name: string, Required. The image import job id. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for 'CancelImageImportJob' 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.
get(name, x__xgafv=None)
Gets details of a single ImageImportJob.

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

Returns:
  An object of the form:

    { # ImageImportJob describes the progress and result of an image import.
  "cloudStorageUri": "A String", # Output only. The path to the Cloud Storage file from which the image should be imported.
  "createTime": "A String", # Output only. The time the image import was created (as an API call, not when it was actually created in the target).
  "createdResources": [ # Output only. The resource paths of the resources created by the image import job.
    "A String",
  ],
  "diskImageTargetDetails": { # The target details of the image resource that will be created by the import job. # Output only. Target details used to import a disk image.
    "additionalLicenses": [ # Optional. Additional licenses to assign to the image.
      "A String",
    ],
    "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process.
    },
    "description": "A String", # Optional. An optional description of the image.
    "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image.
      "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
    },
    "familyName": "A String", # Optional. The name of the image family to which the new image belongs.
    "imageName": "A String", # Required. The name of the image to be created.
    "labels": { # Optional. A map of labels to associate with the image.
      "a_key": "A String",
    },
    "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process.
      "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID).
      "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image.
    },
    "singleRegionStorage": True or False, # Optional. Set to true to set the image storageLocations to the single region of the import job. When false, the closest multi-region is selected.
    "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported image will be created.
  },
  "endTime": "A String", # Output only. The time the image import was ended.
  "errors": [ # Output only. Provides details on the error that led to the image import 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. The resource path of the ImageImportJob.
  "state": "A String", # Output only. The state of the image import.
  "steps": [ # Output only. The image import steps list representing its progress.
    { # ImageImportStep holds information about the image import step progress.
      "adaptingOs": { # AdaptingOSStep contains specific step details. # Adapting OS step.
      },
      "creatingImage": { # CreatingImageStep contains specific step details. # Creating image step.
      },
      "endTime": "A String", # Output only. The time the step has ended.
      "initializing": { # InitializingImageImportStep contains specific step details. # Initializing step.
      },
      "loadingSourceFiles": { # LoadingImageSourceFilesStep contains specific step details. # Loading source files step.
      },
      "startTime": "A String", # Output only. The time the step has started.
    },
  ],
  "warnings": [ # Output only. Warnings that occurred during the image import.
    { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.
      "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning.
        "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
        "message": "A String", # The localized error message in the above locale.
      },
      "code": "A String", # The warning code.
      "helpLinks": [ # URL(s) pointing to additional information on handling the current warning.
        { # Describes a URL link.
          "description": "A String", # Describes what the link offers.
          "url": "A String", # The URL of the link.
        },
      ],
      "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message.
        "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
        "message": "A String", # The localized error message in the above locale.
      },
      "warningTime": "A String", # The time the warning occurred.
    },
  ],
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ImageImportJobs in a given project.

Args:
  parent: string, Required. The parent, which owns this collection of targets. (required)
  filter: string, Optional. The filter request (according to https://google.aip.dev/160).
  orderBy: string, Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field.
  pageSize: integer, Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets 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 `ListImageImportJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListImageImportJobs` 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 'ListImageImportJobs' call.
  "imageImportJobs": [ # Output only. The list of target response.
    { # ImageImportJob describes the progress and result of an image import.
      "cloudStorageUri": "A String", # Output only. The path to the Cloud Storage file from which the image should be imported.
      "createTime": "A String", # Output only. The time the image import was created (as an API call, not when it was actually created in the target).
      "createdResources": [ # Output only. The resource paths of the resources created by the image import job.
        "A String",
      ],
      "diskImageTargetDetails": { # The target details of the image resource that will be created by the import job. # Output only. Target details used to import a disk image.
        "additionalLicenses": [ # Optional. Additional licenses to assign to the image.
          "A String",
        ],
        "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process.
        },
        "description": "A String", # Optional. An optional description of the image.
        "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image.
          "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS.
        },
        "familyName": "A String", # Optional. The name of the image family to which the new image belongs.
        "imageName": "A String", # Required. The name of the image to be created.
        "labels": { # Optional. A map of labels to associate with the image.
          "a_key": "A String",
        },
        "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process.
          "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID).
          "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image.
        },
        "singleRegionStorage": True or False, # Optional. Set to true to set the image storageLocations to the single region of the import job. When false, the closest multi-region is selected.
        "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported image will be created.
      },
      "endTime": "A String", # Output only. The time the image import was ended.
      "errors": [ # Output only. Provides details on the error that led to the image import 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. The resource path of the ImageImportJob.
      "state": "A String", # Output only. The state of the image import.
      "steps": [ # Output only. The image import steps list representing its progress.
        { # ImageImportStep holds information about the image import step progress.
          "adaptingOs": { # AdaptingOSStep contains specific step details. # Adapting OS step.
          },
          "creatingImage": { # CreatingImageStep contains specific step details. # Creating image step.
          },
          "endTime": "A String", # Output only. The time the step has ended.
          "initializing": { # InitializingImageImportStep contains specific step details. # Initializing step.
          },
          "loadingSourceFiles": { # LoadingImageSourceFilesStep contains specific step details. # Loading source files step.
          },
          "startTime": "A String", # Output only. The time the step has started.
        },
      ],
      "warnings": [ # Output only. Warnings that occurred during the image import.
        { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.
          "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning.
            "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
            "message": "A String", # The localized error message in the above locale.
          },
          "code": "A String", # The warning code.
          "helpLinks": [ # URL(s) pointing to additional information on handling the current warning.
            { # Describes a URL link.
              "description": "A String", # Describes what the link offers.
              "url": "A String", # The URL of the link.
            },
          ],
          "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message.
            "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
            "message": "A String", # The localized error message in the above locale.
          },
          "warningTime": "A String", # The time the warning occurred.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # 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.