# VM Migration API . projects . locations . sources

## Instance Methods

Returns the datacenterConnectors Resource.

Returns the migratingVms Resource.

Returns the utilizationReports Resource.

Close httplib2 connections.

Creates a new Source in a given project and location.

Deletes a single Source.

List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

Gets details of a single Source.

Lists Sources in a given project and location.

Retrieves the next page of results.

Updates the parameters of a single Source.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, requestId=None, sourceId=None, x__xgafv=None)`

    Creates a new Source in a given project and location.

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

    { # Source message describes a specific vm migration Source resource. It contains the source environment information.
      "createTime": "A String", # Output only. The create time timestamp.
      "description": "A String", # User-provided description of the source.
      "labels": { # The labels of the source.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The Source name.
      "updateTime": "A String", # Output only. The update time timestamp.
      "vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
        "password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
        "thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
        "username": "A String", # The credentials username.
        "vcenterIp": "A String", # The ip address of the vcenter this Source represents.
      },
    }

      requestId: string, 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 t he request times 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).
      sourceId: string, Required. The source identifier.
      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 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`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, requestId=None, x__xgafv=None)`

    Deletes a single Source.

    Args:
      name: string, Required. The Source name. (required)
      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 after the first request. For example, consider a situation where you make an initial request and t he request times 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 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`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`fetchInventory(source, forceRefresh=None, x__xgafv=None)`

    List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

    Args:
      source: string, Required. The name of the Source. (required)
      forceRefresh: boolean, If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.
      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 fetchInventory.
      "updateTime": "A String", # Output only. The timestamp when the source was last queried (if the result is from the cache).
      "vmwareVms": { # VmwareVmsDetails describes VMs in vCenter. # The description of the VMs in a Source of type Vmware.
        "details": [ # The details of the vmware VMs.
          { # VmwareVmDetails describes a VM in vCenter.
            "bootOption": "A String", # Output only. The VM Boot Option.
            "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
            "cpuCount": 42, # The number of cpus in the VM.
            "datacenterDescription": "A String", # The descriptive name of the vCenter's datacenter this VM is contained in.
            "datacenterId": "A String", # The id of the vCenter's datacenter this VM is contained in.
            "diskCount": 42, # The number of disks the VM has.
            "displayName": "A String", # The display name of the VM. Note that this is not necessarily unique.
            "guestDescription": "A String", # The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
            "memoryMb": 42, # The size of the memory of the VM in MB.
            "powerState": "A String", # The power state of the VM at the moment list was taken.
            "uuid": "A String", # The unique identifier of the VM in vCenter.
            "vmId": "A String", # The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
          },
        ],
      },
    }

`get(name, x__xgafv=None)`

    Gets details of a single Source.

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

    Returns:
      An object of the form:

        { # Source message describes a specific vm migration Source resource. It contains the source environment information.
      "createTime": "A String", # Output only. The create time timestamp.
      "description": "A String", # User-provided description of the source.
      "labels": { # The labels of the source.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The Source name.
      "updateTime": "A String", # Output only. The update time timestamp.
      "vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
        "password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
        "thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
        "username": "A String", # The credentials username.
        "vcenterIp": "A String", # The ip address of the vcenter this Source represents.
      },
    }

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

    Lists Sources in a given project and location.

    Args:
      parent: string, Required. The parent, which owns this collection of sources. (required)
      filter: string, Optional. The filter request.
      orderBy: string, Optional. the order by fields for the result.
      pageSize: integer, Optional. The maximum number of sources to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
      pageToken: string, Required. A page token, received from a previous `ListSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSources` 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 'ListSources' request.
      "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.
      "sources": [ # Output only. The list of sources response.
        { # Source message describes a specific vm migration Source resource. It contains the source environment information.
          "createTime": "A String", # Output only. The create time timestamp.
          "description": "A String", # User-provided description of the source.
          "labels": { # The labels of the source.
            "a_key": "A String",
          },
          "name": "A String", # Output only. The Source name.
          "updateTime": "A String", # Output only. The update time timestamp.
          "vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
            "password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
            "thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
            "username": "A String", # The credentials username.
            "vcenterIp": "A String", # The ip address of the vcenter this Source represents.
          },
        },
      ],
      "unreachable": [ # Output only. Locations that could not be reached.
        "A String",
      ],
    }

`list_next(previous_request, previous_response)`

    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 Source.

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

    { # Source message describes a specific vm migration Source resource. It contains the source environment information.
      "createTime": "A String", # Output only. The create time timestamp.
      "description": "A String", # User-provided description of the source.
      "labels": { # The labels of the source.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The Source name.
      "updateTime": "A String", # Output only. The update time timestamp.
      "vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
        "password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
        "thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
        "username": "A String", # The credentials username.
        "vcenterIp": "A String", # The ip address of the vcenter this Source represents.
      },
    }

      requestId: string, 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 t he request times 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, Field mask is used to specify the fields to be overwritten in the Source 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 all fields will be overwritten.
      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 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`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }