Reference documentation and code samples for the Google Cloud Dataproc Metastore V1alpha Client class Service.
A managed metastore service that serves metadata queries.
Generated from protobuf message google.cloud.metastore.v1alpha.Service
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ hive_metastore_config
Google\Cloud\Metastore\V1alpha\HiveMetastoreConfig
Configuration information specific to running Hive metastore software as the metastore service.
↳ name
string
Immutable. The relative resource name of the metastore service, in the following format: projects/{project_number}/locations/{location_id}/services/{service_id}
.
↳ create_time
Google\Protobuf\Timestamp
Output only. The time when the metastore service was created.
↳ update_time
Google\Protobuf\Timestamp
Output only. The time when the metastore service was last updated.
↳ labels
array|Google\Protobuf\Internal\MapField
User-defined labels for the metastore service.
↳ network
string
Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: projects/{project_number}/global/networks/{network_id}
.
↳ endpoint_uri
string
Output only. The URI of the endpoint used to access the metastore service.
↳ port
int
The TCP port at which the metastore service is reached. Default: 9083.
↳ state
int
Output only. The current state of the metastore service.
↳ state_message
string
Output only. Additional information about the current state of the metastore service, if available.
↳ artifact_gcs_uri
string
Output only. A Cloud Storage URI (starting with gs://
) that specifies where artifacts related to the metastore service are stored.
↳ tier
int
The tier of the service.
↳ metadata_integration
Google\Cloud\Metastore\V1alpha\MetadataIntegration
The setting that defines how metastore metadata should be integrated with external services and systems.
↳ maintenance_window
Google\Cloud\Metastore\V1alpha\MaintenanceWindow
The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.
↳ uid
string
Output only. The globally unique resource identifier of the metastore service.
↳ metadata_management_activity
Google\Cloud\Metastore\V1alpha\MetadataManagementActivity
Output only. The metadata management activities of the metastore service.
↳ release_channel
int
Immutable. The release channel of the service. If unspecified, defaults to STABLE
.
↳ encryption_config
Google\Cloud\Metastore\V1alpha\EncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
↳ network_config
Google\Cloud\Metastore\V1alpha\NetworkConfig
The configuration specifying the network settings for the Dataproc Metastore service.
↳ database_type
int
Immutable. The database type that the Metastore service stores its data.
↳ telemetry_config
Google\Cloud\Metastore\V1alpha\TelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON
.
getHiveMetastoreConfig
Configuration information specific to running Hive metastore software as the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.HiveMetastoreConfig hive_metastore_config = 5;
hasHiveMetastoreConfig
setHiveMetastoreConfig
Configuration information specific to running Hive metastore software as the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.HiveMetastoreConfig hive_metastore_config = 5;
$this
getName
Immutable. The relative resource name of the metastore service, in the
following format: projects/{project_number}/locations/{location_id}/services/{service_id}
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
string
setName
Immutable. The relative resource name of the metastore service, in the
following format: projects/{project_number}/locations/{location_id}/services/{service_id}
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
var
string
$this
getCreateTime
Output only. The time when the metastore service was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the metastore service was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. The time when the metastore service was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the metastore service was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getLabels
User-defined labels for the metastore service.
Generated from protobuf field map<string, string> labels = 4;
Google\Protobuf\Internal\MapField
setLabels
User-defined labels for the metastore service.
Generated from protobuf field map<string, string> labels = 4;
var
array|Google\Protobuf\Internal\MapField
$this
getNetwork
Immutable. The relative resource name of the VPC network on which the
instance can be accessed. It is specified in the following form: projects/{project_number}/global/networks/{network_id}
.
Generated from protobuf field string network = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {
string
setNetwork
Immutable. The relative resource name of the VPC network on which the
instance can be accessed. It is specified in the following form: projects/{project_number}/global/networks/{network_id}
.
Generated from protobuf field string network = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {
var
string
$this
getEndpointUri
Output only. The URI of the endpoint used to access the metastore service.
Generated from protobuf field string endpoint_uri = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setEndpointUri
Output only. The URI of the endpoint used to access the metastore service.
Generated from protobuf field string endpoint_uri = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getPort
The TCP port at which the metastore service is reached. Default: 9083.
Generated from protobuf field int32 port = 9;
int
setPort
The TCP port at which the metastore service is reached. Default: 9083.
Generated from protobuf field int32 port = 9;
var
int
$this
getState
Output only. The current state of the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. The current state of the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getStateMessage
Output only. Additional information about the current state of the metastore service, if available.
Generated from protobuf field string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setStateMessage
Output only. Additional information about the current state of the metastore service, if available.
Generated from protobuf field string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getArtifactGcsUri
Output only. A Cloud Storage URI (starting with gs://
) that specifies
where artifacts related to the metastore service are stored.
Generated from protobuf field string artifact_gcs_uri = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setArtifactGcsUri
Output only. A Cloud Storage URI (starting with gs://
) that specifies
where artifacts related to the metastore service are stored.
Generated from protobuf field string artifact_gcs_uri = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getTier
The tier of the service.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.Tier tier = 13;
int
setTier
The tier of the service.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.Tier tier = 13;
var
int
$this
getMetadataIntegration
The setting that defines how metastore metadata should be integrated with external services and systems.
Generated from protobuf field .google.cloud.metastore.v1alpha.MetadataIntegration metadata_integration = 14;
hasMetadataIntegration
clearMetadataIntegration
setMetadataIntegration
The setting that defines how metastore metadata should be integrated with external services and systems.
Generated from protobuf field .google.cloud.metastore.v1alpha.MetadataIntegration metadata_integration = 14;
$this
getMaintenanceWindow
The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time.
Maintenance window is not needed for services with the SPANNER database type.
Generated from protobuf field .google.cloud.metastore.v1alpha.MaintenanceWindow maintenance_window = 15;
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time.
Maintenance window is not needed for services with the SPANNER database type.
Generated from protobuf field .google.cloud.metastore.v1alpha.MaintenanceWindow maintenance_window = 15;
$this
getUid
Output only. The globally unique resource identifier of the metastore service.
Generated from protobuf field string uid = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setUid
Output only. The globally unique resource identifier of the metastore service.
Generated from protobuf field string uid = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getMetadataManagementActivity
Output only. The metadata management activities of the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.MetadataManagementActivity metadata_management_activity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasMetadataManagementActivity
clearMetadataManagementActivity
setMetadataManagementActivity
Output only. The metadata management activities of the metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.MetadataManagementActivity metadata_management_activity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getReleaseChannel
Immutable. The release channel of the service.
If unspecified, defaults to STABLE
.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.ReleaseChannel release_channel = 19 [(.google.api.field_behavior) = IMMUTABLE];
int
setReleaseChannel
Immutable. The release channel of the service.
If unspecified, defaults to STABLE
.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.ReleaseChannel release_channel = 19 [(.google.api.field_behavior) = IMMUTABLE];
var
int
$this
getEncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
Generated from protobuf field .google.cloud.metastore.v1alpha.EncryptionConfig encryption_config = 20 [(.google.api.field_behavior) = IMMUTABLE];
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
Generated from protobuf field .google.cloud.metastore.v1alpha.EncryptionConfig encryption_config = 20 [(.google.api.field_behavior) = IMMUTABLE];
$this
getNetworkConfig
The configuration specifying the network settings for the Dataproc Metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.NetworkConfig network_config = 21;
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
The configuration specifying the network settings for the Dataproc Metastore service.
Generated from protobuf field .google.cloud.metastore.v1alpha.NetworkConfig network_config = 21;
$this
getDatabaseType
Immutable. The database type that the Metastore service stores its data.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.DatabaseType database_type = 22 [(.google.api.field_behavior) = IMMUTABLE];
int
setDatabaseType
Immutable. The database type that the Metastore service stores its data.
Generated from protobuf field .google.cloud.metastore.v1alpha.Service.DatabaseType database_type = 22 [(.google.api.field_behavior) = IMMUTABLE];
var
int
$this
getTelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore
service. If unspecified defaults to JSON
.
Generated from protobuf field .google.cloud.metastore.v1alpha.TelemetryConfig telemetry_config = 23;
hasTelemetryConfig
clearTelemetryConfig
setTelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore
service. If unspecified defaults to JSON
.
Generated from protobuf field .google.cloud.metastore.v1alpha.TelemetryConfig telemetry_config = 23;
$this
getMetastoreConfig
string
