Interface ServiceOrBuilder (2.42.0)

Version 2.42.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.4
• 2.3.0
• 2.2.0
• 2.1.9

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getArtifactGcsUri()

public abstract String getArtifactGcsUri()

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

string artifact_gcs_uri = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The artifactGcsUri.

getArtifactGcsUriBytes()

public abstract ByteString getArtifactGcsUriBytes()

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

string artifact_gcs_uri = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for artifactGcsUri.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the metastore service was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the metastore service was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDatabaseType()

public abstract Service.DatabaseType getDatabaseType()

Immutable. The database type that the Metastore service stores its data.

.google.cloud.metastore.v1.Service.DatabaseType database_type = 22 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
Service.DatabaseType	The databaseType.

getDatabaseTypeValue()

public abstract int getDatabaseTypeValue()

Immutable. The database type that the Metastore service stores its data.

.google.cloud.metastore.v1.Service.DatabaseType database_type = 22 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for databaseType.

getEncryptionConfig()

public abstract EncryptionConfig getEncryptionConfig()

Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

.google.cloud.metastore.v1.EncryptionConfig encryption_config = 20 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
EncryptionConfig	The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

.google.cloud.metastore.v1.EncryptionConfig encryption_config = 20 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
EncryptionConfigOrBuilder

getEndpointUri()

public abstract String getEndpointUri()

Output only. The URI of the endpoint used to access the metastore service.

string endpoint_uri = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The endpointUri.

getEndpointUriBytes()

public abstract ByteString getEndpointUriBytes()

Output only. The URI of the endpoint used to access the metastore service.

string endpoint_uri = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for endpointUri.

getHiveMetastoreConfig()

public abstract HiveMetastoreConfig getHiveMetastoreConfig()

Configuration information specific to running Hive metastore software as the metastore service.

.google.cloud.metastore.v1.HiveMetastoreConfig hive_metastore_config = 5;

Returns
Type	Description
HiveMetastoreConfig	The hiveMetastoreConfig.

getHiveMetastoreConfigOrBuilder()

public abstract HiveMetastoreConfigOrBuilder getHiveMetastoreConfigOrBuilder()

Configuration information specific to running Hive metastore software as the metastore service.

.google.cloud.metastore.v1.HiveMetastoreConfig hive_metastore_config = 5;

Returns
Type	Description
HiveMetastoreConfigOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-defined labels for the metastore service.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-defined labels for the metastore service.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMaintenanceWindow()

public abstract MaintenanceWindow 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.

.google.cloud.metastore.v1.MaintenanceWindow maintenance_window = 15;

Returns
Type	Description
MaintenanceWindow	The maintenanceWindow.

getMaintenanceWindowOrBuilder()

public abstract MaintenanceWindowOrBuilder getMaintenanceWindowOrBuilder()

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.

.google.cloud.metastore.v1.MaintenanceWindow maintenance_window = 15;

Returns
Type	Description
MaintenanceWindowOrBuilder

getMetadataManagementActivity()

public abstract MetadataManagementActivity getMetadataManagementActivity()

Output only. The metadata management activities of the metastore service.

.google.cloud.metastore.v1.MetadataManagementActivity metadata_management_activity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
MetadataManagementActivity	The metadataManagementActivity.

getMetadataManagementActivityOrBuilder()

public abstract MetadataManagementActivityOrBuilder getMetadataManagementActivityOrBuilder()

Output only. The metadata management activities of the metastore service.

.google.cloud.metastore.v1.MetadataManagementActivity metadata_management_activity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
MetadataManagementActivityOrBuilder

getMetastoreConfigCase()

public abstract Service.MetastoreConfigCase getMetastoreConfigCase()

Returns
Type	Description
Service.MetastoreConfigCase

getName()

public abstract String getName()

Immutable. The relative resource name of the metastore service, in the following format:

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The relative resource name of the metastore service, in the following format:

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

public abstract String 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}.

string network = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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

string network = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for network.

getNetworkConfig()

public abstract NetworkConfig getNetworkConfig()

The configuration specifying the network settings for the Dataproc Metastore service.

.google.cloud.metastore.v1.NetworkConfig network_config = 21;

Returns
Type	Description
NetworkConfig	The networkConfig.

getNetworkConfigOrBuilder()

public abstract NetworkConfigOrBuilder getNetworkConfigOrBuilder()

The configuration specifying the network settings for the Dataproc Metastore service.

.google.cloud.metastore.v1.NetworkConfig network_config = 21;

Returns
Type	Description
NetworkConfigOrBuilder

getPort()

public abstract int getPort()

The TCP port at which the metastore service is reached. Default: 9083.

int32 port = 9;

Returns
Type	Description
int	The port.

getReleaseChannel()

public abstract Service.ReleaseChannel getReleaseChannel()

Immutable. The release channel of the service. If unspecified, defaults to STABLE.

.google.cloud.metastore.v1.Service.ReleaseChannel release_channel = 19 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
Service.ReleaseChannel	The releaseChannel.

getReleaseChannelValue()

public abstract int getReleaseChannelValue()

Immutable. The release channel of the service. If unspecified, defaults to STABLE.

.google.cloud.metastore.v1.Service.ReleaseChannel release_channel = 19 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for releaseChannel.

getScalingConfig()

public abstract ScalingConfig getScalingConfig()

Scaling configuration of the metastore service.

.google.cloud.metastore.v1.ScalingConfig scaling_config = 24;

Returns
Type	Description
ScalingConfig	The scalingConfig.

getScalingConfigOrBuilder()

public abstract ScalingConfigOrBuilder getScalingConfigOrBuilder()

Scaling configuration of the metastore service.

.google.cloud.metastore.v1.ScalingConfig scaling_config = 24;

Returns
Type	Description
ScalingConfigOrBuilder

getState()

public abstract Service.State getState()

Output only. The current state of the metastore service.

.google.cloud.metastore.v1.Service.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Service.State	The state.

getStateMessage()

public abstract String getStateMessage()

Output only. Additional information about the current state of the metastore service, if available.

string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The stateMessage.

getStateMessageBytes()

public abstract ByteString getStateMessageBytes()

Output only. Additional information about the current state of the metastore service, if available.

string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for stateMessage.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the metastore service.

.google.cloud.metastore.v1.Service.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTelemetryConfig()

public abstract TelemetryConfig getTelemetryConfig()

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

.google.cloud.metastore.v1.TelemetryConfig telemetry_config = 23;

Returns
Type	Description
TelemetryConfig	The telemetryConfig.

getTelemetryConfigOrBuilder()

public abstract TelemetryConfigOrBuilder getTelemetryConfigOrBuilder()

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

.google.cloud.metastore.v1.TelemetryConfig telemetry_config = 23;

Returns
Type	Description
TelemetryConfigOrBuilder

getTier()

public abstract Service.Tier getTier()

The tier of the service.

.google.cloud.metastore.v1.Service.Tier tier = 13;

Returns
Type	Description
Service.Tier	The tier.

getTierValue()

public abstract int getTierValue()

The tier of the service.

.google.cloud.metastore.v1.Service.Tier tier = 13;

Returns
Type	Description
int	The enum numeric value on the wire for tier.

getUid()

public abstract String getUid()

Output only. The globally unique resource identifier of the metastore service.

string uid = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. The globally unique resource identifier of the metastore service.

string uid = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time when the metastore service was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the metastore service was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the metastore service was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasEncryptionConfig()

public abstract boolean hasEncryptionConfig()

Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

.google.cloud.metastore.v1.EncryptionConfig encryption_config = 20 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the encryptionConfig field is set.

hasHiveMetastoreConfig()

public abstract boolean hasHiveMetastoreConfig()

Configuration information specific to running Hive metastore software as the metastore service.

.google.cloud.metastore.v1.HiveMetastoreConfig hive_metastore_config = 5;

Returns
Type	Description
boolean	Whether the hiveMetastoreConfig field is set.

hasMaintenanceWindow()

public abstract boolean hasMaintenanceWindow()

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.

.google.cloud.metastore.v1.MaintenanceWindow maintenance_window = 15;

Returns
Type	Description
boolean	Whether the maintenanceWindow field is set.

hasMetadataManagementActivity()

public abstract boolean hasMetadataManagementActivity()

Output only. The metadata management activities of the metastore service.

.google.cloud.metastore.v1.MetadataManagementActivity metadata_management_activity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the metadataManagementActivity field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

The configuration specifying the network settings for the Dataproc Metastore service.

.google.cloud.metastore.v1.NetworkConfig network_config = 21;

Returns
Type	Description
boolean	Whether the networkConfig field is set.

hasScalingConfig()

public abstract boolean hasScalingConfig()

Scaling configuration of the metastore service.

.google.cloud.metastore.v1.ScalingConfig scaling_config = 24;

Returns
Type	Description
boolean	Whether the scalingConfig field is set.

hasTelemetryConfig()

public abstract boolean hasTelemetryConfig()

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

.google.cloud.metastore.v1.TelemetryConfig telemetry_config = 23;

Returns
Type	Description
boolean	Whether the telemetryConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time when the metastore service was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.