Package com.google.cloud.servicedirectory.v1

Class Endpoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.servicedirectory.v1.Endpoint
All Implemented Interfaces:
EndpointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Endpoint extends com.google.protobuf.GeneratedMessage implements EndpointOrBuilder
 An individual endpoint that provides a
 [service][google.cloud.servicedirectory.v1.Service]. The service must
 already exist to create an endpoint.
Protobuf type google.cloud.servicedirectory.v1.Endpoint
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Endpoint.Builder
    An individual endpoint that provides a [service][google.cloud.servicedirectory.v1.Service].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADDRESS_FIELD_NUMBER
     
    static final int
    ANNOTATIONS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    NETWORK_FIELD_NUMBER
     
    static final int
    PORT_FIELD_NUMBER
     
    static final int
    UID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsAnnotations(String key)
    Optional.
    boolean
    equals(Object obj)
     
    String
    getAddress()
    Optional.
    com.google.protobuf.ByteString
    getAddressBytes()
    Optional.
    Map<String,String>
    getAnnotations()
    Deprecated.
    int
    getAnnotationsCount()
    Optional.
    Map<String,String>
    getAnnotationsMap()
    Optional.
    String
    getAnnotationsOrDefault(String key, String defaultValue)
    Optional.
    String
    getAnnotationsOrThrow(String key)
    Optional.
    static Endpoint
    getDefaultInstance()
     
    Endpoint
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Immutable.
    com.google.protobuf.ByteString
    getNameBytes()
    Immutable.
    String
    getNetwork()
    Immutable.
    com.google.protobuf.ByteString
    getNetworkBytes()
    Immutable.
    com.google.protobuf.Parser<Endpoint>
    getParserForType()
     
    int
    getPort()
    Optional.
    int
    getSerializedSize()
     
    String
    getUid()
    Output only.
    com.google.protobuf.ByteString
    getUidBytes()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Endpoint.Builder
    newBuilder()
     
    static Endpoint.Builder
    newBuilder(Endpoint prototype)
     
    Endpoint.Builder
    newBuilderForType()
     
    protected Endpoint.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Endpoint
    parseDelimitedFrom(InputStream input)
     
    static Endpoint
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Endpoint
    parseFrom(byte[] data)
     
    static Endpoint
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Endpoint
    parseFrom(com.google.protobuf.ByteString data)
     
    static Endpoint
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Endpoint
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Endpoint
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Endpoint
    parseFrom(InputStream input)
     
    static Endpoint
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Endpoint
    parseFrom(ByteBuffer data)
     
    static Endpoint
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Endpoint>
    parser()
     
    Endpoint.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

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

    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: EndpointOrBuilder
       Optional. Annotations for the endpoint. This data can be consumed by
 service clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 512 characters,
 spread accoss all key-value pairs. Annotations that go beyond this
 limit are rejected
 *   Valid annotation 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 (/)
 Annotations that fails to meet these requirements are rejected.

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

    • containsAnnotations

      public boolean containsAnnotations(String key)
       Optional. Annotations for the endpoint. This data can be consumed by
 service clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 512 characters,
 spread accoss all key-value pairs. Annotations that go beyond this
 limit are rejected
 *   Valid annotation 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 (/)
 Annotations that fails to meet these requirements are rejected.

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

    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface EndpointOrBuilder

    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       Optional. Annotations for the endpoint. This data can be consumed by
 service clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 512 characters,
 spread accoss all key-value pairs. Annotations that go beyond this
 limit are rejected
 *   Valid annotation 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 (/)
 Annotations that fails to meet these requirements are rejected.

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

    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. Annotations for the endpoint. This data can be consumed by
 service clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 512 characters,
 spread accoss all key-value pairs. Annotations that go beyond this
 limit are rejected
 *   Valid annotation 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 (/)
 Annotations that fails to meet these requirements are rejected.

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

    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       Optional. Annotations for the endpoint. This data can be consumed by
 service clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 512 characters,
 spread accoss all key-value pairs. Annotations that go beyond this
 limit are rejected
 *   Valid annotation 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 (/)
 Annotations that fails to meet these requirements are rejected.

 Note: This field is equivalent to the `metadata` field in the v1beta1 API.
 They have the same syntax and read/write to the same location in Service
 Directory.
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrThrow 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, we also check to make sure
 that you have the servicedirectory.networks.attach permission on the
 project specified.
      string network = 8 [(.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, we also check to make sure
 that you have the servicedirectory.networks.attach permission on the
 project specified.
      string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getNetworkBytes in interface EndpointOrBuilder
      Returns:
      The bytes for network.

    • getUid

      public String getUid()
       Output only. The globally unique identifier of the endpoint in the UUID4
 format.
      string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface EndpointOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. The globally unique identifier of the endpoint in the UUID4
 format.
      string uid = 9 [(.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Endpoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Endpoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Endpoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Endpoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • 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

    • newBuilder

      public static Endpoint.Builder newBuilder()

    • newBuilder

      public static Endpoint.Builder newBuilder(Endpoint prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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