Class Service (2.2.0)

public final class Service extends GeneratedMessageV3 implements ServiceOrBuilder

A managed metastore service that serves metadata queries.

Protobuf type google.cloud.metastore.v1beta.Service

Implements

ServiceOrBuilder

Static Fields

ARTIFACT_GCS_URI_FIELD_NUMBER

public static final int ARTIFACT_GCS_URI_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINT_URI_FIELD_NUMBER

public static final int ENDPOINT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

HIVE_METASTORE_CONFIG_FIELD_NUMBER

public static final int HIVE_METASTORE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MAINTENANCE_WINDOW_FIELD_NUMBER

public static final int MAINTENANCE_WINDOW_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_INTEGRATION_FIELD_NUMBER

public static final int METADATA_INTEGRATION_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_MANAGEMENT_ACTIVITY_FIELD_NUMBER

public static final int METADATA_MANAGEMENT_ACTIVITY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
TypeDescription
int

RELEASE_CHANNEL_FIELD_NUMBER

public static final int RELEASE_CHANNEL_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Service getDefaultInstance()
Returns
TypeDescription
Service

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Service.Builder newBuilder()
Returns
TypeDescription
Service.Builder

newBuilder(Service prototype)

public static Service.Builder newBuilder(Service prototype)
Parameter
NameDescription
prototypeService
Returns
TypeDescription
Service.Builder

parseDelimitedFrom(InputStream input)

public static Service parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Service parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Service parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Service parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Service parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Service parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Service> parser()
Returns
TypeDescription
Parser<Service>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getArtifactGcsUri()

public 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
TypeDescription
String

The artifactGcsUri.

getArtifactGcsUriBytes()

public 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
TypeDescription
ByteString

The bytes for artifactGcsUri.

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Service getDefaultInstanceForType()
Returns
TypeDescription
Service

getEndpointUri()

public 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
TypeDescription
String

The endpointUri.

getEndpointUriBytes()

public 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
TypeDescription
ByteString

The bytes for endpointUri.

getHiveMetastoreConfig()

public HiveMetastoreConfig getHiveMetastoreConfig()

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

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

Returns
TypeDescription
HiveMetastoreConfig

The hiveMetastoreConfig.

getHiveMetastoreConfigOrBuilder()

public HiveMetastoreConfigOrBuilder getHiveMetastoreConfigOrBuilder()

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

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

Returns
TypeDescription
HiveMetastoreConfigOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels for the metastore service.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels for the metastore service.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined labels for the metastore service.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMaintenanceWindow()

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

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

Returns
TypeDescription
MaintenanceWindow

The maintenanceWindow.

getMaintenanceWindowOrBuilder()

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

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

Returns
TypeDescription
MaintenanceWindowOrBuilder

getMetadataIntegration()

public MetadataIntegration getMetadataIntegration()

The setting that defines how metastore metadata should be integrated with external services and systems.

.google.cloud.metastore.v1beta.MetadataIntegration metadata_integration = 14;

Returns
TypeDescription
MetadataIntegration

The metadataIntegration.

getMetadataIntegrationOrBuilder()

public MetadataIntegrationOrBuilder getMetadataIntegrationOrBuilder()

The setting that defines how metastore metadata should be integrated with external services and systems.

.google.cloud.metastore.v1beta.MetadataIntegration metadata_integration = 14;

Returns
TypeDescription
MetadataIntegrationOrBuilder

getMetadataManagementActivity()

public MetadataManagementActivity getMetadataManagementActivity()

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

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

Returns
TypeDescription
MetadataManagementActivity

The metadataManagementActivity.

getMetadataManagementActivityOrBuilder()

public MetadataManagementActivityOrBuilder getMetadataManagementActivityOrBuilder()

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

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

Returns
TypeDescription
MetadataManagementActivityOrBuilder

getMetastoreConfigCase()

public Service.MetastoreConfigCase getMetastoreConfigCase()
Returns
TypeDescription
Service.MetastoreConfigCase

getName()

public String getName()

Immutable. The relative resource name of the metastore service, of the form: projects/{project_number}/locations/{location_id}/services/{service_id}.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The relative resource name of the metastore service, of the form: projects/{project_number}/locations/{location_id}/services/{service_id}.

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

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public 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
TypeDescription
String

The network.

getNetworkBytes()

public 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
TypeDescription
ByteString

The bytes for network.

getParserForType()

public Parser<Service> getParserForType()
Returns
TypeDescription
Parser<Service>
Overrides

getPort()

public int getPort()

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

int32 port = 9;

Returns
TypeDescription
int

The port.

getReleaseChannel()

public Service.ReleaseChannel getReleaseChannel()

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

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

Returns
TypeDescription
Service.ReleaseChannel

The releaseChannel.

getReleaseChannelValue()

public int getReleaseChannelValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for releaseChannel.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Service.State getState()

Output only. The current state of the metastore service.

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

Returns
TypeDescription
Service.State

The state.

getStateMessage()

public 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
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public 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
TypeDescription
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

Output only. The current state of the metastore service.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTier()

public Service.Tier getTier()

The tier of the service.

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

Returns
TypeDescription
Service.Tier

The tier.

getTierValue()

public int getTierValue()

The tier of the service.

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

Returns
TypeDescription
int

The enum numeric value on the wire for tier.

getUid()

public String getUid()

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

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasHiveMetastoreConfig()

public boolean hasHiveMetastoreConfig()

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

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

Returns
TypeDescription
boolean

Whether the hiveMetastoreConfig field is set.

hasMaintenanceWindow()

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

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

Returns
TypeDescription
boolean

Whether the maintenanceWindow field is set.

hasMetadataIntegration()

public boolean hasMetadataIntegration()

The setting that defines how metastore metadata should be integrated with external services and systems.

.google.cloud.metastore.v1beta.MetadataIntegration metadata_integration = 14;

Returns
TypeDescription
boolean

Whether the metadataIntegration field is set.

hasMetadataManagementActivity()

public boolean hasMetadataManagementActivity()

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

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

Returns
TypeDescription
boolean

Whether the metadataManagementActivity field is set.

hasUpdateTime()

public 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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Service.Builder newBuilderForType()
Returns
TypeDescription
Service.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Service.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Service.Builder toBuilder()
Returns
TypeDescription
Service.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException