Package com.google.cloud.servicedirectory.v1

Class Endpoint.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>
com.google.cloud.servicedirectory.v1.Endpoint.Builder
All Implemented Interfaces:
EndpointOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Endpoint
public static final class Endpoint.Builder extends com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder> 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

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

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>

    • clear

      public Endpoint.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Endpoint.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Endpoint.Builder>

    • mergeFrom

      public Endpoint.Builder mergeFrom(Endpoint other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Endpoint.Builder>

    • mergeFrom

      public Endpoint.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Endpoint.Builder>
      Throws:
      IOException

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

    • setName

      public Endpoint.Builder setName(String value)
       Immutable. The resource name for the endpoint in the format
 `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Endpoint.Builder clearName()
       Immutable. The resource name for the endpoint in the format
 `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Endpoint.Builder setNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name for the endpoint in the format
 `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setAddress

      public Endpoint.Builder setAddress(String value)
       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];
      Parameters:
      value - The address to set.
      Returns:
      This builder for chaining.

    • clearAddress

      public Endpoint.Builder clearAddress()
       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];
      Returns:
      This builder for chaining.

    • setAddressBytes

      public Endpoint.Builder setAddressBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for address to set.
      Returns:
      This builder for chaining.

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

    • setPort

      public Endpoint.Builder setPort(int value)
       Optional. Service Directory rejects values outside of `[0, 65535]`.
      int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The port to set.
      Returns:
      This builder for chaining.

    • clearPort

      public Endpoint.Builder clearPort()
       Optional. Service Directory rejects values outside of `[0, 65535]`.
      int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • 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

    • clearAnnotations

      public Endpoint.Builder clearAnnotations()

    • removeAnnotations

      public Endpoint.Builder removeAnnotations(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];

    • getMutableAnnotations

      @Deprecated public Map<String,String> getMutableAnnotations()
      Deprecated.
      Use alternate mutation accessors instead.

    • putAnnotations

      public Endpoint.Builder putAnnotations(String key, String value)
       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];

    • putAllAnnotations

      public Endpoint.Builder putAllAnnotations(Map<String,String> values)
       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];

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

    • setNetwork

      public Endpoint.Builder setNetwork(String value)
       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) = { ... }
      Parameters:
      value - The network to set.
      Returns:
      This builder for chaining.

    • clearNetwork

      public Endpoint.Builder clearNetwork()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setNetworkBytes

      public Endpoint.Builder setNetworkBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for network to set.
      Returns:
      This builder for chaining.

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

    • setUid

      public Endpoint.Builder setUid(String value)
       Output only. The globally unique identifier of the endpoint in the UUID4
 format.
      string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The uid to set.
      Returns:
      This builder for chaining.

    • clearUid

      public Endpoint.Builder clearUid()
       Output only. The globally unique identifier of the endpoint in the UUID4
 format.
      string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setUidBytes

      public Endpoint.Builder setUidBytes(com.google.protobuf.ByteString value)
       Output only. The globally unique identifier of the endpoint in the UUID4
 format.
      string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for uid to set.
      Returns:
      This builder for chaining.