Class Endpoint

  • All Implemented Interfaces:
    EndpointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Endpoint
    extends com.google.protobuf.GeneratedMessageV3
    implements EndpointOrBuilder
     An individual endpoint that provides a
     [service][google.cloud.servicedirectory.v1beta1.Service]. The service must
     already exist to create an endpoint.
     
    Protobuf type google.cloud.servicedirectory.v1beta1.Endpoint
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Endpoint.Builder
      An individual endpoint that provides a [service][google.cloud.servicedirectory.v1beta1.Service].
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • 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 endpoint in the format
         `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
         
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface EndpointOrBuilder
        Returns:
        The name.
      • getNameBytes

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

        public String getAddress()
         Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses
         like:
        
         *   `8.8.8`
         *   `8.8.8.8:53`
         *   `test:bad:address`
         *   `[::1]`
         *   `[::1]:8080`
        
         Limited to 45 characters.
         
        string address = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAddress in interface EndpointOrBuilder
        Returns:
        The address.
      • getAddressBytes

        public com.google.protobuf.ByteString getAddressBytes()
         Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses
         like:
        
         *   `8.8.8`
         *   `8.8.8.8:53`
         *   `test:bad:address`
         *   `[::1]`
         *   `[::1]:8080`
        
         Limited to 45 characters.
         
        string address = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAddressBytes in interface EndpointOrBuilder
        Returns:
        The bytes for address.
      • getPort

        public int getPort()
         Optional. Service Directory rejects values outside of `[0, 65535]`.
         
        int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPort in interface EndpointOrBuilder
        Returns:
        The port.
      • getMetadataCount

        public int getMetadataCount()
        Description copied from interface: EndpointOrBuilder
         Optional. Metadata for the endpoint. This data can be consumed by service
         clients.
        
         Restrictions:
        
         *   The entire metadata dictionary may contain up to 512 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataCount in interface EndpointOrBuilder
      • containsMetadata

        public boolean containsMetadata​(String key)
         Optional. Metadata for the endpoint. This data can be consumed by service
         clients.
        
         Restrictions:
        
         *   The entire metadata dictionary may contain up to 512 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsMetadata in interface EndpointOrBuilder
      • getMetadataMap

        public Map<String,​String> getMetadataMap()
         Optional. Metadata for the endpoint. This data can be consumed by service
         clients.
        
         Restrictions:
        
         *   The entire metadata dictionary may contain up to 512 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataMap in interface EndpointOrBuilder
      • getMetadataOrDefault

        public String getMetadataOrDefault​(String key,
                                           String defaultValue)
         Optional. Metadata for the endpoint. This data can be consumed by service
         clients.
        
         Restrictions:
        
         *   The entire metadata dictionary may contain up to 512 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataOrDefault in interface EndpointOrBuilder
      • getMetadataOrThrow

        public String getMetadataOrThrow​(String key)
         Optional. Metadata for the endpoint. This data can be consumed by service
         clients.
        
         Restrictions:
        
         *   The entire metadata dictionary may contain up to 512 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMetadataOrThrow in interface EndpointOrBuilder
      • getNetwork

        public String getNetwork()
         Immutable. The Google Compute Engine network (VPC) of the endpoint in the
         format `projects/<project number>/locations/global/networks/*`.
        
         The project must be specified by project number (project id is rejected).
         Incorrectly formatted networks are rejected, but no other validation
         is performed on this field (ex. network or project existence, reachability,
         or permissions).
         
        string network = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getNetwork in interface EndpointOrBuilder
        Returns:
        The network.
      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         Immutable. The Google Compute Engine network (VPC) of the endpoint in the
         format `projects/<project number>/locations/global/networks/*`.
        
         The project must be specified by project number (project id is rejected).
         Incorrectly formatted networks are rejected, but no other validation
         is performed on this field (ex. network or project existence, reachability,
         or permissions).
         
        string network = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getNetworkBytes in interface EndpointOrBuilder
        Returns:
        The bytes for network.
      • hasCreateTime

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

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

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

        public boolean hasUpdateTime()
         Output only. The timestamp when the endpoint was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface EndpointOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when the endpoint was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface EndpointOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when the endpoint was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface EndpointOrBuilder
      • getUid

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

        public com.google.protobuf.ByteString getUidBytes()
         Output only. A globally unique identifier (in UUID4 format) for this
         endpoint.
         
        string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface EndpointOrBuilder
        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 Endpoint parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static Endpoint getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Endpoint> parser()
      • getParserForType

        public com.google.protobuf.Parser<Endpoint> 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 Endpoint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder