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

      int getMetadataCount()
       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];
    • containsMetadata

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

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
    • getMetadataMap

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

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

      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];
    • 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, 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) = { ... }
      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, 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) = { ... }
      Returns:
      The bytes for network.
    • hasCreateTime

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

      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];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

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

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

      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];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

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

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

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