File: metastore_v2beta.projects.locations.services.html

package info (click to toggle)
python-googleapi 2.180.0-1
links: PTS
area: main
in suites: forky, sid
size: 527,124 kB
sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (1093 lines) | stat: -rw-r--r-- 99,543 bytes
parent folder | download | duplicates (2)
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="metastore_v2beta.html">Dataproc Metastore API</a> . <a href="metastore_v2beta.projects.html">projects</a> . <a href="metastore_v2beta.projects.locations.html">locations</a> . <a href="metastore_v2beta.projects.locations.services.html">services</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="metastore_v2beta.projects.locations.services.backups.html">backups()</a></code>
</p>
<p class="firstline">Returns the backups Resource.</p>

<p class="toc_element">
  <code><a href="metastore_v2beta.projects.locations.services.migrationExecutions.html">migrationExecutions()</a></code>
</p>
<p class="firstline">Returns the migrationExecutions Resource.</p>

<p class="toc_element">
  <code><a href="#alterLocation">alterLocation(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.</p>
<p class="toc_element">
  <code><a href="#alterTableProperties">alterTableProperties(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Alter metadata table properties.</p>
<p class="toc_element">
  <code><a href="#cancelMigration">cancelMigration(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels the ongoing Managed Migration process.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#completeMigration">completeMigration(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a metastore service in a project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single service.</p>
<p class="toc_element">
  <code><a href="#exportMetadata">exportMetadata(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports metadata from a service.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a single service.</p>
<p class="toc_element">
  <code><a href="#importMetadata">importMetadata(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports Metadata into a Dataproc Metastore service.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists services in a project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#moveTableToDatabase">moveTableToDatabase(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Move a table to another database.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single service.</p>
<p class="toc_element">
  <code><a href="#queryMetadata">queryMetadata(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Query Dataproc Metastore metadata.</p>
<p class="toc_element">
  <code><a href="#removeIamPolicy">removeIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes the attached IAM policies for a resource</p>
<p class="toc_element">
  <code><a href="#restore">restore(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a service from a backup.</p>
<p class="toc_element">
  <code><a href="#startMigration">startMigration(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts the Managed Migration process.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="alterLocation">alterLocation(service, body=None, x__xgafv=None)</code>
  <pre>Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.

Args:
  service: string, Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.AlterMetadataResourceLocation.
  &quot;locationUri&quot;: &quot;A String&quot;, # Required. The new location URI for the metadata resource.
  &quot;resourceName&quot;: &quot;A String&quot;, # Required. The relative metadata resource name in the following format.databases/{database_id} or databases/{database_id}/tables/{table_id} or databases/{database_id}/tables/{table_id}/partitions/{partition_id}
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="alterTableProperties">alterTableProperties(service, body=None, x__xgafv=None)</code>
  <pre>Alter metadata table properties.

Args:
  service: string, Required. The relative resource name of the Dataproc Metastore service that&#x27;s being used to mutate metadata table properties, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.AlterTableProperties.
  &quot;properties&quot;: { # A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;tableName&quot;: &quot;A String&quot;, # Required. The name of the table containing the properties you&#x27;re altering in the following format.databases/{database_id}/tables/{table_id}
  &quot;updateMask&quot;: &quot;A String&quot;, # A field mask that specifies the metadata table properties that are overwritten by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: &quot;properties.b&quot;, &quot;properties.c&quot;then the result will be: properties { a: 1 b: 3 c: 4 }
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="cancelMigration">cancelMigration(service, body=None, x__xgafv=None)</code>
  <pre>Cancels the ongoing Managed Migration process.

Args:
  service: string, Required. The relative resource name of the metastore service to cancel the ongoing migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.CancelMigration.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="completeMigration">completeMigration(service, body=None, x__xgafv=None)</code>
  <pre>Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.

Args:
  service: string, Required. The relative resource name of the metastore service to complete the migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.CompleteMigration.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</code>
  <pre>Creates a metastore service in a project and location.

Args:
  parent: string, Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # A managed metastore service that serves metadata queries.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was created.
  &quot;encryptionConfig&quot;: { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
  },
  &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the metastore service.
    { # An endpoint used to access the metastore service.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
      &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
    },
  ],
  &quot;hiveMetastoreConfig&quot;: { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
    &quot;auxiliaryVersions&quot;: { # Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service&#x27;s primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
      &quot;a_key&quot;: { # Configuration information for the auxiliary service versions.
        &quot;configOverrides&quot;: { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version&#x27;s overrides. If keys are present in both the auxiliary version&#x27;s overrides and the primary version&#x27;s overrides, the value from the auxiliary version&#x27;s overrides takes precedence.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the auxiliary metastore service, includes version and region data.
          { # An endpoint used to access the metastore service.
            &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
            &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
          },
        ],
        &quot;version&quot;: &quot;A String&quot;, # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service&#x27;s version.
      },
    },
    &quot;configOverrides&quot;: { # Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version&#x27;s AuxiliaryVersionConfig.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;endpointProtocol&quot;: &quot;A String&quot;, # Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to GRPC.
    &quot;version&quot;: &quot;A String&quot;, # Immutable. The Hive metastore schema version.
  },
  &quot;labels&quot;: { # User-defined labels for the metastore service.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadataIntegration&quot;: { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
    &quot;dataCatalogConfig&quot;: { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
      &quot;enabled&quot;: True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
  &quot;scalingConfig&quot;: { # Represents the scaling configuration of a metastore service. # Optional. Scaling configuration of the metastore service.
    &quot;autoscalingConfig&quot;: { # Represents the autoscaling configuration of a metastore service. # Optional. The autoscaling configuration.
      &quot;autoscalingEnabled&quot;: True or False, # Optional. Whether or not autoscaling is enabled for this service.
      &quot;autoscalingFactor&quot;: 42, # Output only. The scaling factor of a service with autoscaling enabled.
      &quot;limitConfig&quot;: { # Represents the autoscaling limit configuration of a metastore service. # Optional. The LimitConfig of the service.
        &quot;maxScalingFactor&quot;: 42, # Optional. The highest scaling factor that the service should be autoscaled to.
        &quot;minScalingFactor&quot;: 42, # Optional. The lowest scaling factor that the service should be autoscaled to.
      },
    },
    &quot;scalingFactor&quot;: 42, # Optional. Scaling factor from 1 to 5, increments of 1.
  },
  &quot;scheduledBackup&quot;: { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
    &quot;backupLocation&quot;: &quot;A String&quot;, # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
    &quot;cronSchedule&quot;: &quot;A String&quot;, # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
    &quot;enabled&quot;: True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
    &quot;latestBackup&quot;: { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
      &quot;backupId&quot;: &quot;A String&quot;, # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
      &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the backup completion.
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was started.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
    },
    &quot;nextScheduledTime&quot;: &quot;A String&quot;, # Output only. The time when the next backups execution is scheduled to start.
    &quot;timeZone&quot;: &quot;A String&quot;, # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
  },
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metastore service.
  &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of the metastore service, if available.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The globally unique resource identifier of the metastore service.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was last updated.
  &quot;warehouseGcsUri&quot;: &quot;A String&quot;, # Required. A Cloud Storage URI (starting with gs://) that specifies the default warehouse directory of the Hive Metastore.
}

  requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  serviceId: string, Required. The ID of the metastore service, which is used as the final component of the metastore service&#x27;s name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
  <pre>Deletes a single service.

Args:
  name: string, Required. The relative resource name of the metastore service to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
  requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="exportMetadata">exportMetadata(service, body=None, x__xgafv=None)</code>
  <pre>Exports metadata from a service.

Args:
  service: string, Required. The relative resource name of the metastore service to run export, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.ExportMetadata.
  &quot;databaseDumpType&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
  &quot;destinationGcsFolder&quot;: &quot;A String&quot;, # A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing exported files will be created below it.
  &quot;requestId&quot;: &quot;A String&quot;, # Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets the details of a single service.

Args:
  name: string, Required. The relative resource name of the metastore service to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A managed metastore service that serves metadata queries.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was created.
  &quot;encryptionConfig&quot;: { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
  },
  &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the metastore service.
    { # An endpoint used to access the metastore service.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
      &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
    },
  ],
  &quot;hiveMetastoreConfig&quot;: { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
    &quot;auxiliaryVersions&quot;: { # Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service&#x27;s primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
      &quot;a_key&quot;: { # Configuration information for the auxiliary service versions.
        &quot;configOverrides&quot;: { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version&#x27;s overrides. If keys are present in both the auxiliary version&#x27;s overrides and the primary version&#x27;s overrides, the value from the auxiliary version&#x27;s overrides takes precedence.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the auxiliary metastore service, includes version and region data.
          { # An endpoint used to access the metastore service.
            &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
            &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
          },
        ],
        &quot;version&quot;: &quot;A String&quot;, # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service&#x27;s version.
      },
    },
    &quot;configOverrides&quot;: { # Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version&#x27;s AuxiliaryVersionConfig.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;endpointProtocol&quot;: &quot;A String&quot;, # Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to GRPC.
    &quot;version&quot;: &quot;A String&quot;, # Immutable. The Hive metastore schema version.
  },
  &quot;labels&quot;: { # User-defined labels for the metastore service.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadataIntegration&quot;: { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
    &quot;dataCatalogConfig&quot;: { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
      &quot;enabled&quot;: True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
  &quot;scalingConfig&quot;: { # Represents the scaling configuration of a metastore service. # Optional. Scaling configuration of the metastore service.
    &quot;autoscalingConfig&quot;: { # Represents the autoscaling configuration of a metastore service. # Optional. The autoscaling configuration.
      &quot;autoscalingEnabled&quot;: True or False, # Optional. Whether or not autoscaling is enabled for this service.
      &quot;autoscalingFactor&quot;: 42, # Output only. The scaling factor of a service with autoscaling enabled.
      &quot;limitConfig&quot;: { # Represents the autoscaling limit configuration of a metastore service. # Optional. The LimitConfig of the service.
        &quot;maxScalingFactor&quot;: 42, # Optional. The highest scaling factor that the service should be autoscaled to.
        &quot;minScalingFactor&quot;: 42, # Optional. The lowest scaling factor that the service should be autoscaled to.
      },
    },
    &quot;scalingFactor&quot;: 42, # Optional. Scaling factor from 1 to 5, increments of 1.
  },
  &quot;scheduledBackup&quot;: { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
    &quot;backupLocation&quot;: &quot;A String&quot;, # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
    &quot;cronSchedule&quot;: &quot;A String&quot;, # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
    &quot;enabled&quot;: True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
    &quot;latestBackup&quot;: { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
      &quot;backupId&quot;: &quot;A String&quot;, # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
      &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the backup completion.
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was started.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
    },
    &quot;nextScheduledTime&quot;: &quot;A String&quot;, # Output only. The time when the next backups execution is scheduled to start.
    &quot;timeZone&quot;: &quot;A String&quot;, # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
  },
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metastore service.
  &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of the metastore service, if available.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The globally unique resource identifier of the metastore service.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was last updated.
  &quot;warehouseGcsUri&quot;: &quot;A String&quot;, # Required. A Cloud Storage URI (starting with gs://) that specifies the default warehouse directory of the Hive Metastore.
}</pre>
</div>

<div class="method">
    <code class="details" id="importMetadata">importMetadata(name, body=None, x__xgafv=None)</code>
  <pre>Imports Metadata into a Dataproc Metastore service.

Args:
  name: string, Immutable. The relative resource name of the metastore service to run import, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.CreateMetadataImport.
  &quot;databaseDump&quot;: { # A specification of the location and metadata type for a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore&#x27;s database.
    &quot;gcsUri&quot;: &quot;A String&quot;, # Required. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
    &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
  },
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the metadata import.
  &quot;requestId&quot;: &quot;A String&quot;, # Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists services in a project and location.

Args:
  parent: string, Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}. (required)
  filter: string, Optional. The filter to apply to list results.
  orderBy: string, Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.
  pageSize: integer, Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.
  pageToken: string, Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices 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 DataprocMetastore.ListServices.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;services&quot;: [ # The services in the specified location.
    { # A managed metastore service that serves metadata queries.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was created.
      &quot;encryptionConfig&quot;: { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
      },
      &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the metastore service.
        { # An endpoint used to access the metastore service.
          &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
          &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
        },
      ],
      &quot;hiveMetastoreConfig&quot;: { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
        &quot;auxiliaryVersions&quot;: { # Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service&#x27;s primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
          &quot;a_key&quot;: { # Configuration information for the auxiliary service versions.
            &quot;configOverrides&quot;: { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version&#x27;s overrides. If keys are present in both the auxiliary version&#x27;s overrides and the primary version&#x27;s overrides, the value from the auxiliary version&#x27;s overrides takes precedence.
              &quot;a_key&quot;: &quot;A String&quot;,
            },
            &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the auxiliary metastore service, includes version and region data.
              { # An endpoint used to access the metastore service.
                &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
                &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
              },
            ],
            &quot;version&quot;: &quot;A String&quot;, # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service&#x27;s version.
          },
        },
        &quot;configOverrides&quot;: { # Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version&#x27;s AuxiliaryVersionConfig.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;endpointProtocol&quot;: &quot;A String&quot;, # Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to GRPC.
        &quot;version&quot;: &quot;A String&quot;, # Immutable. The Hive metastore schema version.
      },
      &quot;labels&quot;: { # User-defined labels for the metastore service.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;metadataIntegration&quot;: { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
        &quot;dataCatalogConfig&quot;: { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
          &quot;enabled&quot;: True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
      &quot;scalingConfig&quot;: { # Represents the scaling configuration of a metastore service. # Optional. Scaling configuration of the metastore service.
        &quot;autoscalingConfig&quot;: { # Represents the autoscaling configuration of a metastore service. # Optional. The autoscaling configuration.
          &quot;autoscalingEnabled&quot;: True or False, # Optional. Whether or not autoscaling is enabled for this service.
          &quot;autoscalingFactor&quot;: 42, # Output only. The scaling factor of a service with autoscaling enabled.
          &quot;limitConfig&quot;: { # Represents the autoscaling limit configuration of a metastore service. # Optional. The LimitConfig of the service.
            &quot;maxScalingFactor&quot;: 42, # Optional. The highest scaling factor that the service should be autoscaled to.
            &quot;minScalingFactor&quot;: 42, # Optional. The lowest scaling factor that the service should be autoscaled to.
          },
        },
        &quot;scalingFactor&quot;: 42, # Optional. Scaling factor from 1 to 5, increments of 1.
      },
      &quot;scheduledBackup&quot;: { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
        &quot;backupLocation&quot;: &quot;A String&quot;, # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
        &quot;cronSchedule&quot;: &quot;A String&quot;, # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
        &quot;enabled&quot;: True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
        &quot;latestBackup&quot;: { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
          &quot;backupId&quot;: &quot;A String&quot;, # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
          &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the backup completion.
          &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was started.
          &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
        },
        &quot;nextScheduledTime&quot;: &quot;A String&quot;, # Output only. The time when the next backups execution is scheduled to start.
        &quot;timeZone&quot;: &quot;A String&quot;, # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
      },
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metastore service.
      &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of the metastore service, if available.
      &quot;uid&quot;: &quot;A String&quot;, # Output only. The globally unique resource identifier of the metastore service.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was last updated.
      &quot;warehouseGcsUri&quot;: &quot;A String&quot;, # Required. A Cloud Storage URI (starting with gs://) that specifies the default warehouse directory of the Hive Metastore.
    },
  ],
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="moveTableToDatabase">moveTableToDatabase(service, body=None, x__xgafv=None)</code>
  <pre>Move a table to another database.

Args:
  service: string, Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.MoveTableToDatabase.
  &quot;dbName&quot;: &quot;A String&quot;, # Required. The name of the database where the table resides.
  &quot;destinationDbName&quot;: &quot;A String&quot;, # Required. The name of the database where the table should be moved.
  &quot;tableName&quot;: &quot;A String&quot;, # Required. The name of the table to be moved.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single service.

Args:
  name: string, Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # A managed metastore service that serves metadata queries.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was created.
  &quot;encryptionConfig&quot;: { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
  },
  &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the metastore service.
    { # An endpoint used to access the metastore service.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
      &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
    },
  ],
  &quot;hiveMetastoreConfig&quot;: { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
    &quot;auxiliaryVersions&quot;: { # Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service&#x27;s primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
      &quot;a_key&quot;: { # Configuration information for the auxiliary service versions.
        &quot;configOverrides&quot;: { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version&#x27;s overrides. If keys are present in both the auxiliary version&#x27;s overrides and the primary version&#x27;s overrides, the value from the auxiliary version&#x27;s overrides takes precedence.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;endpoints&quot;: [ # Output only. The list of endpoints used to access the auxiliary metastore service, includes version and region data.
          { # An endpoint used to access the metastore service.
            &quot;endpointUri&quot;: &quot;A String&quot;, # Output only. The URI of the endpoint used to access the metastore service.
            &quot;region&quot;: &quot;A String&quot;, # Output only. The region where the endpoint is located.
          },
        ],
        &quot;version&quot;: &quot;A String&quot;, # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service&#x27;s version.
      },
    },
    &quot;configOverrides&quot;: { # Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version&#x27;s AuxiliaryVersionConfig.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;endpointProtocol&quot;: &quot;A String&quot;, # Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to GRPC.
    &quot;version&quot;: &quot;A String&quot;, # Immutable. The Hive metastore schema version.
  },
  &quot;labels&quot;: { # User-defined labels for the metastore service.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadataIntegration&quot;: { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
    &quot;dataCatalogConfig&quot;: { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
      &quot;enabled&quot;: True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
  &quot;scalingConfig&quot;: { # Represents the scaling configuration of a metastore service. # Optional. Scaling configuration of the metastore service.
    &quot;autoscalingConfig&quot;: { # Represents the autoscaling configuration of a metastore service. # Optional. The autoscaling configuration.
      &quot;autoscalingEnabled&quot;: True or False, # Optional. Whether or not autoscaling is enabled for this service.
      &quot;autoscalingFactor&quot;: 42, # Output only. The scaling factor of a service with autoscaling enabled.
      &quot;limitConfig&quot;: { # Represents the autoscaling limit configuration of a metastore service. # Optional. The LimitConfig of the service.
        &quot;maxScalingFactor&quot;: 42, # Optional. The highest scaling factor that the service should be autoscaled to.
        &quot;minScalingFactor&quot;: 42, # Optional. The lowest scaling factor that the service should be autoscaled to.
      },
    },
    &quot;scalingFactor&quot;: 42, # Optional. Scaling factor from 1 to 5, increments of 1.
  },
  &quot;scheduledBackup&quot;: { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
    &quot;backupLocation&quot;: &quot;A String&quot;, # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
    &quot;cronSchedule&quot;: &quot;A String&quot;, # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
    &quot;enabled&quot;: True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
    &quot;latestBackup&quot;: { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
      &quot;backupId&quot;: &quot;A String&quot;, # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
      &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the backup completion.
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was started.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
    },
    &quot;nextScheduledTime&quot;: &quot;A String&quot;, # Output only. The time when the next backups execution is scheduled to start.
    &quot;timeZone&quot;: &quot;A String&quot;, # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
  },
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metastore service.
  &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of the metastore service, if available.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The globally unique resource identifier of the metastore service.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metastore service was last updated.
  &quot;warehouseGcsUri&quot;: &quot;A String&quot;, # Required. A Cloud Storage URI (starting with gs://) that specifies the default warehouse directory of the Hive Metastore.
}

  requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  updateMask: string, Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="queryMetadata">queryMetadata(service, body=None, x__xgafv=None)</code>
  <pre>Query Dataproc Metastore metadata.

Args:
  service: string, Required. The relative resource name of the metastore service to query metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.QueryMetadata.
  &quot;query&quot;: &quot;A String&quot;, # Required. A read-only SQL query to execute against the metadata database. The query cannot change or mutate the data.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="removeIamPolicy">removeIamPolicy(resource, body=None, x__xgafv=None)</code>
  <pre>Removes the attached IAM policies for a resource

Args:
  resource: string, Required. The relative resource name of the dataplane resource to remove IAM policy, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id} or projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.RemoveIamPolicy.
  &quot;asynchronous&quot;: True or False, # Optional. Removes IAM policy attached to database or table asynchronously when it is set. The default is false.
}

  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 DataprocMetastore.RemoveIamPolicy.
  &quot;success&quot;: True or False, # True if the policy is successfully removed.
}</pre>
</div>

<div class="method">
    <code class="details" id="restore">restore(service, body=None, x__xgafv=None)</code>
  <pre>Restores a service from a backup.

Args:
  service: string, Required. The relative resource name of the metastore service to run restore, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.Restore.
  &quot;backup&quot;: &quot;A String&quot;, # Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.
  &quot;backupLocation&quot;: &quot;A String&quot;, # Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under &quot;avro/&quot;, backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.
  &quot;requestId&quot;: &quot;A String&quot;, # Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  &quot;restoreType&quot;: &quot;A String&quot;, # Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="startMigration">startMigration(service, body=None, x__xgafv=None)</code>
  <pre>Starts the Managed Migration process.

Args:
  service: string, Required. The relative resource name of the metastore service to start migrating to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataprocMetastore.StartMigration.
  &quot;migrationExecution&quot;: { # The details of a migration execution resource. # Required. The configuration details for the migration.
    &quot;cloudSqlMigrationConfig&quot;: { # Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore.
      &quot;cdcConfig&quot;: { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration.
        &quot;bucket&quot;: &quot;A String&quot;, # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like &quot;gs://&quot;. See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used.
        &quot;password&quot;: &quot;A String&quot;, # Required. Input only. The password for the user that Datastream service should use for the MySQL connection. This field is not returned on request.
        &quot;reverseProxySubnet&quot;: &quot;A String&quot;, # Required. The URL of the subnetwork resource to create the VM instance hosting the reverse proxy in. More context in https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy The subnetwork should reside in the network provided in the request that Datastream will peer to and should be in the same region as Datastream, in the following format. projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}
        &quot;rootPath&quot;: &quot;A String&quot;, # Optional. The root path inside the Cloud Storage bucket. The stream event data will be written to this path. The default value is /migration.
        &quot;subnetIpRange&quot;: &quot;A String&quot;, # Required. A /29 CIDR IP range for peering with datastream.
        &quot;username&quot;: &quot;A String&quot;, # Required. The username that the Datastream service should use for the MySQL connection.
        &quot;vpcNetwork&quot;: &quot;A String&quot;, # Required. Fully qualified name of the Cloud SQL instance&#x27;s VPC network or the shared VPC network that Datastream will peer to, in the following format: projects/{project_id}/locations/global/networks/{network_id}. More context in https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity
      },
      &quot;cloudSqlConnectionConfig&quot;: { # Configuration information to establish customer database connection before the cutover phase of migration # Required. Configuration information to establish customer database connection before the cutover phase of migration
        &quot;hiveDatabaseName&quot;: &quot;A String&quot;, # Required. The hive database name.
        &quot;instanceConnectionName&quot;: &quot;A String&quot;, # Required. Cloud SQL database connection name (project_id:region:instance_name)
        &quot;ipAddress&quot;: &quot;A String&quot;, # Required. The private IP address of the Cloud SQL instance.
        &quot;natSubnet&quot;: &quot;A String&quot;, # Required. The relative resource name of the subnetwork to be used for Private Service Connect. Note that this cannot be a regular subnet and is used only for NAT. (https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets) This subnet is used to publish the SOCKS5 proxy service. The subnet size must be at least /29 and it should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}
        &quot;password&quot;: &quot;A String&quot;, # Required. Input only. The password for the user that Dataproc Metastore service will be using to connect to the database. This field is not returned on request.
        &quot;port&quot;: 42, # Required. The network port of the database.
        &quot;proxySubnet&quot;: &quot;A String&quot;, # Required. The relative resource name of the subnetwork to deploy the SOCKS5 proxy service in. The subnetwork should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}
        &quot;username&quot;: &quot;A String&quot;, # Required. The username that Dataproc Metastore service will use to connect to the database.
      },
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the migration execution was started.
    &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the migration execution finished.
    &quot;name&quot;: &quot;A String&quot;, # Output only. The relative resource name of the migration execution, in the following form: projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}
    &quot;phase&quot;: &quot;A String&quot;, # Output only. The current phase of the migration execution.
    &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the migration execution.
    &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of the migration execution.
  },
  &quot;requestId&quot;: &quot;A String&quot;, # Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}.
  &quot;response&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>