Class Service (0.17.0)

public final class Service extends GeneratedMessageV3 implements ServiceOrBuilder

Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.

Protobuf type google.cloud.apphub.v1.Service

Implements

ServiceOrBuilder

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERED_SERVICE_FIELD_NUMBER

public static final int DISCOVERED_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_PROPERTIES_FIELD_NUMBER

public static final int SERVICE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_REFERENCE_FIELD_NUMBER

public static final int SERVICE_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Service getDefaultInstance()
Returns
Type Description
Service

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Service.Builder newBuilder()
Returns
Type Description
Service.Builder

newBuilder(Service prototype)

public static Service.Builder newBuilder(Service prototype)
Parameter
Name Description
prototype Service
Returns
Type Description
Service.Builder

parseDelimitedFrom(InputStream input)

public static Service parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Service parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Service parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Service parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Service parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Service parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Service> parser()
Returns
Type Description
Parser<Service>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttributes()

public Attributes getAttributes()

Optional. Consumer provided attributes.

.google.cloud.apphub.v1.Attributes attributes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Attributes

The attributes.

getAttributesOrBuilder()

public AttributesOrBuilder getAttributesOrBuilder()

Optional. Consumer provided attributes.

.google.cloud.apphub.v1.Attributes attributes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributesOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Service getDefaultInstanceForType()
Returns
Type Description
Service

getDescription()

public String getDescription()

Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDiscoveredService()

public String getDiscoveredService()

Required. Immutable. The resource name of the original discovered service.

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

Returns
Type Description
String

The discoveredService.

getDiscoveredServiceBytes()

public ByteString getDiscoveredServiceBytes()

Required. Immutable. The resource name of the original discovered service.

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

Returns
Type Description
ByteString

The bytes for discoveredService.

getDisplayName()

public String getDisplayName()

Optional. User-defined name for the Service. Can have a maximum length of 63 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User-defined name for the Service. Can have a maximum length of 63 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Service> getParserForType()
Returns
Type Description
Parser<Service>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceProperties()

public ServiceProperties getServiceProperties()

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceProperties service_properties = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceProperties

The serviceProperties.

getServicePropertiesOrBuilder()

public ServicePropertiesOrBuilder getServicePropertiesOrBuilder()

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceProperties service_properties = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServicePropertiesOrBuilder

getServiceReference()

public ServiceReference getServiceReference()

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceReference service_reference = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceReference

The serviceReference.

getServiceReferenceOrBuilder()

public ServiceReferenceOrBuilder getServiceReferenceOrBuilder()

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceReference service_reference = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceReferenceOrBuilder

getState()

public Service.State getState()

Output only. Service state.

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

Returns
Type Description
Service.State

The state.

getStateValue()

public int getStateValue()

Output only. Service state.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time.

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

Returns
Type Description
TimestampOrBuilder

hasAttributes()

public boolean hasAttributes()

Optional. Consumer provided attributes.

.google.cloud.apphub.v1.Attributes attributes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the attributes field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasServiceProperties()

public boolean hasServiceProperties()

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceProperties service_properties = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the serviceProperties field is set.

hasServiceReference()

public boolean hasServiceReference()

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

.google.cloud.apphub.v1.ServiceReference service_reference = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the serviceReference field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Service.Builder newBuilderForType()
Returns
Type Description
Service.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Service.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Service.Builder toBuilder()
Returns
Type Description
Service.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException