Dataproc Metastore V1 API - Class Google::Cloud::Metastore::V1::Service (v0.12.2)

Version 0.12.2

• 1.0.1 (latest)
• 1.0.0
• 0.13.0
• 0.12.2
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.2

Reference documentation and code samples for the Dataproc Metastore V1 API class Google::Cloud::Metastore::V1::Service.

A managed metastore service that serves metadata queries.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#artifact_gcs_uri

def artifact_gcs_uri() -> ::String

Returns

• (::String) — Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time when the metastore service was created.

#database_type

def database_type() -> ::Google::Cloud::Metastore::V1::Service::DatabaseType

Returns

• (::Google::Cloud::Metastore::V1::Service::DatabaseType) — Immutable. The database type that the Metastore service stores its data.

#database_type=

def database_type=(value) -> ::Google::Cloud::Metastore::V1::Service::DatabaseType

Parameter

• value (::Google::Cloud::Metastore::V1::Service::DatabaseType) — Immutable. The database type that the Metastore service stores its data.

Returns

• (::Google::Cloud::Metastore::V1::Service::DatabaseType) — Immutable. The database type that the Metastore service stores its data.

#encryption_config

def encryption_config() -> ::Google::Cloud::Metastore::V1::EncryptionConfig

Returns

• (::Google::Cloud::Metastore::V1::EncryptionConfig) — Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Metastore::V1::EncryptionConfig

Parameter

• value (::Google::Cloud::Metastore::V1::EncryptionConfig) — Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

Returns

• (::Google::Cloud::Metastore::V1::EncryptionConfig) — Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

#endpoint_uri

def endpoint_uri() -> ::String

Returns

• (::String) — Output only. The URI of the endpoint used to access the metastore service.

#hive_metastore_config

def hive_metastore_config() -> ::Google::Cloud::Metastore::V1::HiveMetastoreConfig

Returns

• (::Google::Cloud::Metastore::V1::HiveMetastoreConfig) — Configuration information specific to running Hive metastore software as the metastore service.

#hive_metastore_config=

def hive_metastore_config=(value) -> ::Google::Cloud::Metastore::V1::HiveMetastoreConfig

Parameter

• value (::Google::Cloud::Metastore::V1::HiveMetastoreConfig) — Configuration information specific to running Hive metastore software as the metastore service.

Returns

• (::Google::Cloud::Metastore::V1::HiveMetastoreConfig) — Configuration information specific to running Hive metastore software as the metastore service.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — User-defined labels for the metastore service.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — User-defined labels for the metastore service.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — User-defined labels for the metastore service.

#maintenance_window

def maintenance_window() -> ::Google::Cloud::Metastore::V1::MaintenanceWindow

Returns

• (::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.

#maintenance_window=

def maintenance_window=(value) -> ::Google::Cloud::Metastore::V1::MaintenanceWindow

Parameter

• value (::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.

Returns

• (::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.

#metadata_management_activity

def metadata_management_activity() -> ::Google::Cloud::Metastore::V1::MetadataManagementActivity

Returns

• (::Google::Cloud::Metastore::V1::MetadataManagementActivity) — Output only. The metadata management activities of the metastore service.

#name

def name() -> ::String

Returns

• (::String) — Immutable. The relative resource name of the metastore service, in the following format:

  projects/{project_number}/locations/{location_id}/services/{service_id}.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Immutable. The relative resource name of the metastore service, in the following format:

  projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns

• (::String) — Immutable. The relative resource name of the metastore service, in the following format:

  projects/{project_number}/locations/{location_id}/services/{service_id}.

#network

def network() -> ::String

Returns

• (::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}.

#network=

def network=(value) -> ::String

Parameter

• value (::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}.

Returns

• (::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}.

#network_config

def network_config() -> ::Google::Cloud::Metastore::V1::NetworkConfig

Returns

• (::Google::Cloud::Metastore::V1::NetworkConfig) — The configuration specifying the network settings for the Dataproc Metastore service.

#network_config=

def network_config=(value) -> ::Google::Cloud::Metastore::V1::NetworkConfig

Parameter

• value (::Google::Cloud::Metastore::V1::NetworkConfig) — The configuration specifying the network settings for the Dataproc Metastore service.

Returns

• (::Google::Cloud::Metastore::V1::NetworkConfig) — The configuration specifying the network settings for the Dataproc Metastore service.

#port

def port() -> ::Integer

Returns

• (::Integer) — The TCP port at which the metastore service is reached. Default: 9083.

#port=

def port=(value) -> ::Integer

Parameter

• value (::Integer) — The TCP port at which the metastore service is reached. Default: 9083.

Returns

• (::Integer) — The TCP port at which the metastore service is reached. Default: 9083.

#release_channel

def release_channel() -> ::Google::Cloud::Metastore::V1::Service::ReleaseChannel

Returns

• (::Google::Cloud::Metastore::V1::Service::ReleaseChannel) — Immutable. The release channel of the service. If unspecified, defaults to STABLE.

#release_channel=

def release_channel=(value) -> ::Google::Cloud::Metastore::V1::Service::ReleaseChannel

Parameter

• value (::Google::Cloud::Metastore::V1::Service::ReleaseChannel) — Immutable. The release channel of the service. If unspecified, defaults to STABLE.

Returns

• (::Google::Cloud::Metastore::V1::Service::ReleaseChannel) — Immutable. The release channel of the service. If unspecified, defaults to STABLE.

#scaling_config

def scaling_config() -> ::Google::Cloud::Metastore::V1::ScalingConfig

Returns

• (::Google::Cloud::Metastore::V1::ScalingConfig) — Scaling configuration of the metastore service.

#scaling_config=

def scaling_config=(value) -> ::Google::Cloud::Metastore::V1::ScalingConfig

Parameter

• value (::Google::Cloud::Metastore::V1::ScalingConfig) — Scaling configuration of the metastore service.

Returns

• (::Google::Cloud::Metastore::V1::ScalingConfig) — Scaling configuration of the metastore service.

#state

def state() -> ::Google::Cloud::Metastore::V1::Service::State

Returns

• (::Google::Cloud::Metastore::V1::Service::State) — Output only. The current state of the metastore service.

#state_message

def state_message() -> ::String

Returns

• (::String) — Output only. Additional information about the current state of the metastore service, if available.

#telemetry_config

def telemetry_config() -> ::Google::Cloud::Metastore::V1::TelemetryConfig

Returns

• (::Google::Cloud::Metastore::V1::TelemetryConfig) — The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

#telemetry_config=

def telemetry_config=(value) -> ::Google::Cloud::Metastore::V1::TelemetryConfig

Parameter

• value (::Google::Cloud::Metastore::V1::TelemetryConfig) — The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

Returns

• (::Google::Cloud::Metastore::V1::TelemetryConfig) — The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

#tier

def tier() -> ::Google::Cloud::Metastore::V1::Service::Tier

Returns

• (::Google::Cloud::Metastore::V1::Service::Tier) — The tier of the service.

#tier=

def tier=(value) -> ::Google::Cloud::Metastore::V1::Service::Tier

Parameter

• value (::Google::Cloud::Metastore::V1::Service::Tier) — The tier of the service.

Returns

• (::Google::Cloud::Metastore::V1::Service::Tier) — The tier of the service.

#uid

def uid() -> ::String

Returns

• (::String) — Output only. The globally unique resource identifier of the metastore service.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time when the metastore service was last updated.