# Migration Center API . projects . locations . discoveryClients

## Instance Methods

Close httplib2 connections.

Creates a new discovery client.

Deletes a discovery client.

Gets the details of a discovery client.

Lists all the discovery clients in a given project and location.

Retrieves the next page of results.

Updates a discovery client.

Sends a discovery client heartbeat. Healthy clients are expected to send heartbeats regularly (normally every few minutes).

### Method Details

`close()`

    Close httplib2 connections.

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

    Creates a new discovery client.

    Args:
      parent: string, Required. Parent resource. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents an installed Migration Center Discovery Client instance.
      "createTime": "A String", # Output only. Time when the discovery client was first created.
      "description": "A String", # Optional. Free text description. Maximum length is 1000 characters.
      "displayName": "A String", # Optional. Free text display name. Maximum length is 63 characters.
      "errors": [ # Output only. Errors affecting client functionality.
        { # 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.
        },
      ],
      "expireTime": "A String", # Optional. Client expiration time in UTC. If specified, the backend will not accept new frames after this time.
      "heartbeatTime": "A String", # Output only. Last heartbeat time. Healthy clients are expected to send heartbeats regularly (normally every few minutes).
      "labels": { # Optional. Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Identifier. Full name of this discovery client.
      "recommendedVersions": [ # Output only. The recommended versions of the discovery client.
        { # Discovery client recommended version.
          "uri": "A String", # Output only. The URI of the discovery client version.
          "version": "A String", # Output only. The version of the discovery client.
        },
      ],
      "serviceAccount": "A String", # Required. Service account used by the discovery client for various operation.
      "signalsEndpoint": "A String", # Output only. This field is intended for internal use.
      "source": "A String", # Required. Full name of the source object associated with this discovery client.
      "state": "A String", # Output only. Current state of the discovery client.
      "ttl": "A String", # Optional. Input only. Client time-to-live. If specified, the backend will not accept new frames after this time. This field is input only. The derived expiration time is provided as output through the `expire_time` field.
      "updateTime": "A String", # Output only. Time when the discovery client was last updated. This value is not updated by heartbeats, to view the last heartbeat time please refer to the `heartbeat_time` field.
      "version": "A String", # Output only. Client version, as reported in recent heartbeat.
    }

      discoveryClientId: string, Required. User specified ID for the discovery client. It will become the last component of the discovery client name. The ID must be unique within the project, is restricted to lower-cased letters and has a maximum length of 63 characters. The ID must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
      requestId: string, Optional. An optional 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 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, 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, requestId=None, x__xgafv=None)`

    Deletes a discovery client.

    Args:
      name: string, Required. The discovery client name. (required)
      requestId: string, Optional. An optional 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 the 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, 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 the details of a discovery client.

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

    Returns:
      An object of the form:

        { # Represents an installed Migration Center Discovery Client instance.
      "createTime": "A String", # Output only. Time when the discovery client was first created.
      "description": "A String", # Optional. Free text description. Maximum length is 1000 characters.
      "displayName": "A String", # Optional. Free text display name. Maximum length is 63 characters.
      "errors": [ # Output only. Errors affecting client functionality.
        { # 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.
        },
      ],
      "expireTime": "A String", # Optional. Client expiration time in UTC. If specified, the backend will not accept new frames after this time.
      "heartbeatTime": "A String", # Output only. Last heartbeat time. Healthy clients are expected to send heartbeats regularly (normally every few minutes).
      "labels": { # Optional. Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Identifier. Full name of this discovery client.
      "recommendedVersions": [ # Output only. The recommended versions of the discovery client.
        { # Discovery client recommended version.
          "uri": "A String", # Output only. The URI of the discovery client version.
          "version": "A String", # Output only. The version of the discovery client.
        },
      ],
      "serviceAccount": "A String", # Required. Service account used by the discovery client for various operation.
      "signalsEndpoint": "A String", # Output only. This field is intended for internal use.
      "source": "A String", # Required. Full name of the source object associated with this discovery client.
      "state": "A String", # Output only. Current state of the discovery client.
      "ttl": "A String", # Optional. Input only. Client time-to-live. If specified, the backend will not accept new frames after this time. This field is input only. The derived expiration time is provided as output through the `expire_time` field.
      "updateTime": "A String", # Output only. Time when the discovery client was last updated. This value is not updated by heartbeats, to view the last heartbeat time please refer to the `heartbeat_time` field.
      "version": "A String", # Output only. Client version, as reported in recent heartbeat.
    }

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

    Lists all the discovery clients in a given project and location.

    Args:
      parent: string, Required. Parent resource. (required)
      filter: string, Optional. Filter expression to filter results by.
      orderBy: string, Optional. Field to sort by.
      pageSize: integer, Optional. The maximum number of items to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.
      pageToken: string, Optional. A page token, received from a previous `ListDiscoveryClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDiscoveryClients` 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 listing discovery clients.
      "discoveryClients": [ # List of discovery clients.
        { # Represents an installed Migration Center Discovery Client instance.
          "createTime": "A String", # Output only. Time when the discovery client was first created.
          "description": "A String", # Optional. Free text description. Maximum length is 1000 characters.
          "displayName": "A String", # Optional. Free text display name. Maximum length is 63 characters.
          "errors": [ # Output only. Errors affecting client functionality.
            { # 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.
            },
          ],
          "expireTime": "A String", # Optional. Client expiration time in UTC. If specified, the backend will not accept new frames after this time.
          "heartbeatTime": "A String", # Output only. Last heartbeat time. Healthy clients are expected to send heartbeats regularly (normally every few minutes).
          "labels": { # Optional. Labels as key value pairs.
            "a_key": "A String",
          },
          "name": "A String", # Output only. Identifier. Full name of this discovery client.
          "recommendedVersions": [ # Output only. The recommended versions of the discovery client.
            { # Discovery client recommended version.
              "uri": "A String", # Output only. The URI of the discovery client version.
              "version": "A String", # Output only. The version of the discovery client.
            },
          ],
          "serviceAccount": "A String", # Required. Service account used by the discovery client for various operation.
          "signalsEndpoint": "A String", # Output only. This field is intended for internal use.
          "source": "A String", # Required. Full name of the source object associated with this discovery client.
          "state": "A String", # Output only. Current state of the discovery client.
          "ttl": "A String", # Optional. Input only. Client time-to-live. If specified, the backend will not accept new frames after this time. This field is input only. The derived expiration time is provided as output through the `expire_time` field.
          "updateTime": "A String", # Output only. Time when the discovery client was last updated. This value is not updated by heartbeats, to view the last heartbeat time please refer to the `heartbeat_time` field.
          "version": "A String", # Output only. Client version, as reported in recent heartbeat.
        },
      ],
      "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
      "unreachable": [ # 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 a discovery client.

    Args:
      name: string, Output only. Identifier. Full name of this discovery client. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents an installed Migration Center Discovery Client instance.
      "createTime": "A String", # Output only. Time when the discovery client was first created.
      "description": "A String", # Optional. Free text description. Maximum length is 1000 characters.
      "displayName": "A String", # Optional. Free text display name. Maximum length is 63 characters.
      "errors": [ # Output only. Errors affecting client functionality.
        { # 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.
        },
      ],
      "expireTime": "A String", # Optional. Client expiration time in UTC. If specified, the backend will not accept new frames after this time.
      "heartbeatTime": "A String", # Output only. Last heartbeat time. Healthy clients are expected to send heartbeats regularly (normally every few minutes).
      "labels": { # Optional. Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Identifier. Full name of this discovery client.
      "recommendedVersions": [ # Output only. The recommended versions of the discovery client.
        { # Discovery client recommended version.
          "uri": "A String", # Output only. The URI of the discovery client version.
          "version": "A String", # Output only. The version of the discovery client.
        },
      ],
      "serviceAccount": "A String", # Required. Service account used by the discovery client for various operation.
      "signalsEndpoint": "A String", # Output only. This field is intended for internal use.
      "source": "A String", # Required. Full name of the source object associated with this discovery client.
      "state": "A String", # Output only. Current state of the discovery client.
      "ttl": "A String", # Optional. Input only. Client time-to-live. If specified, the backend will not accept new frames after this time. This field is input only. The derived expiration time is provided as output through the `expire_time` field.
      "updateTime": "A String", # Output only. Time when the discovery client was last updated. This value is not updated by heartbeats, to view the last heartbeat time please refer to the `heartbeat_time` field.
      "version": "A String", # Output only. Client version, as reported in recent heartbeat.
    }

      requestId: string, Optional. An optional 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 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, Required. Update mask is used to specify the fields to be overwritten in the `DiscoveryClient` resource by the update. The values specified in the `update_mask` field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
      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.
      },
    }

`sendHeartbeat(name, body=None, x__xgafv=None)`

    Sends a discovery client heartbeat. Healthy clients are expected to send heartbeats regularly (normally every few minutes).

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

    { # A request to send a discovery client heartbeat.
      "errors": [ # Optional. Errors affecting client functionality.
        { # 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.
        },
      ],
      "version": "A String", # Optional. Client application version.
    }

      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.
      },
    }