Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class Service.
A managed metastore service that serves metadata queries.
Generated from protobuf message google.cloud.metastore.v1.Service
Namespace
Google \ Cloud \ Metastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ hive_metastore_config |
Google\Cloud\Metastore\V1\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: |
↳ 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: |
↳ 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 |
↳ tier |
int
The tier of the service. |
↳ maintenance_window |
Google\Cloud\Metastore\V1\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\V1\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 |
↳ encryption_config |
Google\Cloud\Metastore\V1\EncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated. |
↳ network_config |
Google\Cloud\Metastore\V1\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\V1\TelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to |
↳ scaling_config |
Google\Cloud\Metastore\V1\ScalingConfig
Scaling configuration of the metastore service. |
getHiveMetastoreConfig
Configuration information specific to running Hive metastore software as the metastore service.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\HiveMetastoreConfig|null |
|
hasHiveMetastoreConfig
setHiveMetastoreConfig
Configuration information specific to running Hive metastore software as the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\HiveMetastoreConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Immutable. The relative resource name of the metastore service, in the
following format:
projects/{project_number}/locations/{location_id}/services/{service_id}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. The relative resource name of the metastore service, in the
following format:
projects/{project_number}/locations/{location_id}/services/{service_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the metastore service was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the metastore service was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the metastore service was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the metastore service was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
User-defined labels for the metastore service.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
User-defined labels for the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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}.
| Returns | |
|---|---|
| Type | Description |
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}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpointUri
Output only. The URI of the endpoint used to access the metastore service.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEndpointUri
Output only. The URI of the endpoint used to access the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPort
The TCP port at which the metastore service is reached. Default: 9083.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPort
The TCP port at which the metastore service is reached. Default: 9083.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the metastore service.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The current state of the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateMessage
Output only. Additional information about the current state of the metastore service, if available.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStateMessage
Output only. Additional information about the current state of the metastore service, if available.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArtifactGcsUri
Output only. A Cloud Storage URI (starting with gs://) that specifies
where artifacts related to the metastore service are stored.
| Returns | |
|---|---|
| Type | Description |
string |
|
setArtifactGcsUri
Output only. A Cloud Storage URI (starting with gs://) that specifies
where artifacts related to the metastore service are stored.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTier
The tier of the service.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTier
The tier of the service.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\MaintenanceWindow|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\MaintenanceWindow
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. The globally unique resource identifier of the metastore service.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. The globally unique resource identifier of the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadataManagementActivity
Output only. The metadata management activities of the metastore service.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\MetadataManagementActivity|null |
|
hasMetadataManagementActivity
clearMetadataManagementActivity
setMetadataManagementActivity
Output only. The metadata management activities of the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\MetadataManagementActivity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReleaseChannel
Immutable. The release channel of the service.
If unspecified, defaults to STABLE.
| Returns | |
|---|---|
| Type | Description |
int |
|
setReleaseChannel
Immutable. The release channel of the service.
If unspecified, defaults to STABLE.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\EncryptionConfig|null |
|
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\EncryptionConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkConfig
The configuration specifying the network settings for the Dataproc Metastore service.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\NetworkConfig|null |
|
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
The configuration specifying the network settings for the Dataproc Metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\NetworkConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseType
Immutable. The database type that the Metastore service stores its data.
| Returns | |
|---|---|
| Type | Description |
int |
|
setDatabaseType
Immutable. The database type that the Metastore service stores its data.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore
service. If unspecified defaults to JSON.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\TelemetryConfig|null |
|
hasTelemetryConfig
clearTelemetryConfig
setTelemetryConfig
The configuration specifying telemetry settings for the Dataproc Metastore
service. If unspecified defaults to JSON.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\TelemetryConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScalingConfig
Scaling configuration of the metastore service.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Metastore\V1\ScalingConfig|null |
|
hasScalingConfig
clearScalingConfig
setScalingConfig
Scaling configuration of the metastore service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Metastore\V1\ScalingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetastoreConfig
| Returns | |
|---|---|
| Type | Description |
string |
|