Package com.google.cloud.servicedirectory.v1beta1

Class Service

  • All Implemented Interfaces:
    ServiceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Service
extends com.google.protobuf.GeneratedMessageV3
implements ServiceOrBuilder
     An individual service. A service contains a name and optional metadata.
 A service must exist before
 [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be
 added to it.
    Protobuf type google.cloud.servicedirectory.v1beta1.Service
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Immutable. The resource name for the service in the format
 `projects/*/locations/*/namespaces/*/services/*`.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface ServiceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. The resource name for the service in the format
 `projects/*/locations/*/namespaces/*/services/*`.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface ServiceOrBuilder
        Returns:
        The bytes for name.

      • getMetadataCount

        public int getMetadataCount()
        Description copied from interface: ServiceOrBuilder
         Optional. Metadata for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire metadata dictionary may contain up to 2000 characters,
     spread accoss all key-value pairs. Metadata that goes beyond this
     limit are rejected
 *   Valid metadata keys have two segments: an optional prefix and name,
     separated by a slash (/). The name segment is required and must be 63
     characters or less, beginning and ending with an alphanumeric character
     ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
     alphanumerics between. The prefix is optional. If specified, the prefix
     must be a DNS subdomain: a series of DNS labels separated by dots (.),
     not longer than 253 characters in total, followed by a slash (/).
     Metadata that fails to meet these requirements are rejected

 Note: This field is equivalent to the `annotations` field in the v1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
        map<string, string> metadata = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataCount in interface ServiceOrBuilder

      • containsMetadata

        public boolean containsMetadata​(String key)
         Optional. Metadata for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire metadata dictionary may contain up to 2000 characters,
     spread accoss all key-value pairs. Metadata that goes beyond this
     limit are rejected
 *   Valid metadata keys have two segments: an optional prefix and name,
     separated by a slash (/). The name segment is required and must be 63
     characters or less, beginning and ending with an alphanumeric character
     ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
     alphanumerics between. The prefix is optional. If specified, the prefix
     must be a DNS subdomain: a series of DNS labels separated by dots (.),
     not longer than 253 characters in total, followed by a slash (/).
     Metadata that fails to meet these requirements are rejected

 Note: This field is equivalent to the `annotations` field in the v1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
        map<string, string> metadata = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsMetadata in interface ServiceOrBuilder

      • getMetadataMap

        public Map<String,​String> getMetadataMap()
         Optional. Metadata for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire metadata dictionary may contain up to 2000 characters,
     spread accoss all key-value pairs. Metadata that goes beyond this
     limit are rejected
 *   Valid metadata keys have two segments: an optional prefix and name,
     separated by a slash (/). The name segment is required and must be 63
     characters or less, beginning and ending with an alphanumeric character
     ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
     alphanumerics between. The prefix is optional. If specified, the prefix
     must be a DNS subdomain: a series of DNS labels separated by dots (.),
     not longer than 253 characters in total, followed by a slash (/).
     Metadata that fails to meet these requirements are rejected

 Note: This field is equivalent to the `annotations` field in the v1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
        map<string, string> metadata = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataMap in interface ServiceOrBuilder

      • getMetadataOrDefault

        public String getMetadataOrDefault​(String key,
                                   String defaultValue)
         Optional. Metadata for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire metadata dictionary may contain up to 2000 characters,
     spread accoss all key-value pairs. Metadata that goes beyond this
     limit are rejected
 *   Valid metadata keys have two segments: an optional prefix and name,
     separated by a slash (/). The name segment is required and must be 63
     characters or less, beginning and ending with an alphanumeric character
     ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
     alphanumerics between. The prefix is optional. If specified, the prefix
     must be a DNS subdomain: a series of DNS labels separated by dots (.),
     not longer than 253 characters in total, followed by a slash (/).
     Metadata that fails to meet these requirements are rejected

 Note: This field is equivalent to the `annotations` field in the v1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
        map<string, string> metadata = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataOrDefault in interface ServiceOrBuilder

      • getMetadataOrThrow

        public String getMetadataOrThrow​(String key)
         Optional. Metadata for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire metadata dictionary may contain up to 2000 characters,
     spread accoss all key-value pairs. Metadata that goes beyond this
     limit are rejected
 *   Valid metadata keys have two segments: an optional prefix and name,
     separated by a slash (/). The name segment is required and must be 63
     characters or less, beginning and ending with an alphanumeric character
     ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
     alphanumerics between. The prefix is optional. If specified, the prefix
     must be a DNS subdomain: a series of DNS labels separated by dots (.),
     not longer than 253 characters in total, followed by a slash (/).
     Metadata that fails to meet these requirements are rejected

 Note: This field is equivalent to the `annotations` field in the v1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
        map<string, string> metadata = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataOrThrow in interface ServiceOrBuilder

      • getEndpointsList

        public List<Endpoint> getEndpointsList()
         Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
        repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointsList in interface ServiceOrBuilder

      • getEndpointsOrBuilderList

        public List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()
         Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
        repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointsOrBuilderList in interface ServiceOrBuilder

      • getEndpointsCount

        public int getEndpointsCount()
         Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
        repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointsCount in interface ServiceOrBuilder

      • getEndpoints

        public Endpoint getEndpoints​(int index)
         Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
        repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpoints in interface ServiceOrBuilder

      • getEndpointsOrBuilder

        public EndpointOrBuilder getEndpointsOrBuilder​(int index)
         Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
        repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndpointsOrBuilder in interface ServiceOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The timestamp when the service was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ServiceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when the service was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ServiceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when the service was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ServiceOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The timestamp when the service was last updated. Note:
 endpoints being created/deleted/updated within the service are not
 considered service updates for the purpose of this timestamp.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ServiceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when the service was last updated. Note:
 endpoints being created/deleted/updated within the service are not
 considered service updates for the purpose of this timestamp.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ServiceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when the service was last updated. Note:
 endpoints being created/deleted/updated within the service are not
 considered service updates for the purpose of this timestamp.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ServiceOrBuilder

      • getUid

        public String getUid()
         Output only. A globally unique identifier (in UUID4 format) for this
 service.
        string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface ServiceOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. A globally unique identifier (in UUID4 format) for this
 service.
        string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface ServiceOrBuilder
        Returns:
        The bytes for uid.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Service parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Service.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Service.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Service.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Service getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Service> parser()

      • getParserForType

        public com.google.protobuf.Parser<Service> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Service getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder