Google Cloud Dataproc Metastore V1alpha Client - Class ExportMetadataRequest (0.4.1)

Reference documentation and code samples for the Google Cloud Dataproc Metastore V1alpha Client class ExportMetadataRequest.

Request message for DataprocMetastore.ExportMetadata.

Generated from protobuf message google.cloud.metastore.v1alpha.ExportMetadataRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ destination_gcs_folder string

A Cloud Storage URI of a folder, in the format gs://<bucket_name>/<path_inside_bucket>. A sub-folder <export_folder> containing exported files will be created below it.

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

↳ request_id 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. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

↳ database_dump_type int

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

getDestinationGcsFolder

A Cloud Storage URI of a folder, in the format gs://<bucket_name>/<path_inside_bucket>. A sub-folder <export_folder> containing exported files will be created below it.

Generated from protobuf field string destination_gcs_folder = 2;

Returns
TypeDescription
string

hasDestinationGcsFolder

setDestinationGcsFolder

A Cloud Storage URI of a folder, in the format gs://<bucket_name>/<path_inside_bucket>. A sub-folder <export_folder> containing exported files will be created below it.

Generated from protobuf field string destination_gcs_folder = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getService

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

Generated from protobuf field string service = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setService

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

Generated from protobuf field string service = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestId

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. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setRequestId

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. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDatabaseDumpType

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

Generated from protobuf field .google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type database_dump_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

setDatabaseDumpType

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

Generated from protobuf field .google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type database_dump_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDestination

Returns
TypeDescription
string