Package com.google.cloud.servicedirectory.v1

Interface EndpointOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Endpoint, Endpoint.Builder
@Generated public interface EndpointOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getAddress

      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];
      Returns:
      The address.

    • getAddressBytes

      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];
      Returns:
      The bytes for address.

    • getPort

      int getPort()
       Optional. Service Directory rejects values outside of `[0, 65535]`.
      int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The port.

    • getAnnotationsCount

      int getAnnotationsCount()
       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];

    • containsAnnotations

      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];

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      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];

    • getAnnotationsOrDefault

      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];

    • getAnnotationsOrThrow

      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];

    • getNetwork

      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) = { ... }
      Returns:
      The network.

    • getNetworkBytes

      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) = { ... }
      Returns:
      The bytes for network.

    • getUid

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

    • getUidBytes

      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];
      Returns:
      The bytes for uid.