View Source GoogleApi.DataMigration.V1beta1.Api.Projects (google_api_data_migration v0.21.0)

API calls for all endpoints tagged Projects.

Summary

Functions

datamigration_projects_locations_connection_profiles_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new connection profile in a given project and location.

datamigration_projects_locations_connection_profiles_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

datamigration_projects_locations_connection_profiles_get(connection, name, optional_params \\ [], opts \\ [])

Gets details of a single connection profile.

datamigration_projects_locations_connection_profiles_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

datamigration_projects_locations_connection_profiles_list(connection, parent, optional_params \\ [], opts \\ [])

Retrieve a list of all connection profiles in a given project and location.

datamigration_projects_locations_connection_profiles_patch(connection, name, optional_params \\ [], opts \\ [])

Update the configuration of a single connection profile.

datamigration_projects_locations_connection_profiles_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

datamigration_projects_locations_connection_profiles_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

datamigration_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])

Gets information about a location.

datamigration_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])

Lists information about the supported locations for this service.

datamigration_projects_locations_migration_jobs_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new migration job in a given project and location.

datamigration_projects_locations_migration_jobs_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a single migration job.

datamigration_projects_locations_migration_jobs_generate_ssh_script(connection, migration_job, optional_params \\ [], opts \\ [])

Generate a SSH configuration script to configure the reverse SSH connectivity.

datamigration_projects_locations_migration_jobs_get(connection, name, optional_params \\ [], opts \\ [])

Gets details of a single migration job.

datamigration_projects_locations_migration_jobs_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

datamigration_projects_locations_migration_jobs_list(connection, parent, optional_params \\ [], opts \\ [])

Lists migration jobs in a given project and location.

datamigration_projects_locations_migration_jobs_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the parameters of a single migration job.

datamigration_projects_locations_migration_jobs_promote(connection, name, optional_params \\ [], opts \\ [])

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

datamigration_projects_locations_migration_jobs_restart(connection, name, optional_params \\ [], opts \\ [])

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

datamigration_projects_locations_migration_jobs_resume(connection, name, optional_params \\ [], opts \\ [])

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

datamigration_projects_locations_migration_jobs_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

datamigration_projects_locations_migration_jobs_start(connection, name, optional_params \\ [], opts \\ [])

Start an already created migration job.

datamigration_projects_locations_migration_jobs_stop(connection, name, optional_params \\ [], opts \\ [])

Stops a running migration job.

datamigration_projects_locations_migration_jobs_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

datamigration_projects_locations_migration_jobs_verify(connection, name, optional_params \\ [], opts \\ [])

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

datamigration_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

datamigration_projects_locations_operations_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

datamigration_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

datamigration_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Functions

datamigration_projects_locations_connection_profiles_create(connection, parent, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new connection profile in a given project and location.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of connection profiles.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :connectionProfileId (type: String.t) - Required. The connection profile identifier.
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.ConnectionProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_delete(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the connection profile resource to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_get(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.ConnectionProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details of a single connection profile.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the connection profile resource to get.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.ConnectionProfile{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"options.requestedPolicyVersion" (type: integer()) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_list(connection, parent, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataMigration.V1beta1.Model.ListConnectionProfilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve a list of all connection profiles in a given project and location.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of connection profiles.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.
    • :orderBy (type: String.t) - the order by fields for the result.
    • :pageSize (type: integer()) - The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - A page token, received from a previous ListConnectionProfiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConnectionProfiles must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.ListConnectionProfilesResponse{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_patch(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the configuration of a single connection profile.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
    • :updateMask (type: String.t) - Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.ConnectionProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure

datamigration_projects_locations_connection_profiles_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_connection_profiles_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure

datamigration_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Location.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about a location.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Resource name for the location.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Location{}} on success
  • {:error, info} on failure

datamigration_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.ListLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists information about the supported locations for this service.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The resource that owns the locations collection, if applicable.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
    • :pageSize (type: integer()) - The maximum number of results to return. If not set, the service selects a default.
    • :pageToken (type: String.t) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.ListLocationsResponse{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_create(connection, parent, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new migration job in a given project and location.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of migration jobs.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :migrationJobId (type: String.t) - Required. The ID of the instance to create.
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.MigrationJob.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_delete(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a single migration job.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the migration job resource to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_generate_ssh_script(connection, migration_job, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_generate_ssh_script(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.SshScript.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generate a SSH configuration script to configure the reverse SSH connectivity.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • migration_job (type: String.t) - Name of the migration job resource to generate the SSH script.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.GenerateSshScriptRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.SshScript{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_get(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.MigrationJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details of a single migration job.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the migration job resource to get.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.MigrationJob{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"options.requestedPolicyVersion" (type: integer()) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_list(connection, parent, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.ListMigrationJobsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists migration jobs in a given project and location.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of migrationJobs.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.
    • :orderBy (type: String.t) - Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".
    • :pageSize (type: integer()) - The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.ListMigrationJobsResponse{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_patch(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the parameters of a single migration job.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :requestId (type: String.t) - A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
    • :updateMask (type: String.t) - Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.MigrationJob.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_promote(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_promote(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to promote.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.PromoteMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_restart(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_restart(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to restart.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.RestartMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_resume(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_resume(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to resume.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.ResumeMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_start(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_start(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Start an already created migration job.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to start.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.StartMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_stop(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_stop(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Stops a running migration job.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to stop.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.StopMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure

datamigration_projects_locations_migration_jobs_verify(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_migration_jobs_verify(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the migration job resource to verify.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.VerifyMigrationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be cancelled.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataMigration.V1beta1.Model.CancelOperationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure

datamigration_projects_locations_operations_delete(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_operations_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be deleted.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure

datamigration_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.Operation{}} on success
  • {:error, info} on failure

datamigration_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])

@spec datamigration_projects_locations_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataMigration.V1beta1.Model.ListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.DataMigration.V1beta1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation's parent resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataMigration.V1beta1.Model.ListOperationsResponse{}} on success
  • {:error, info} on failure