Interface ServiceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Service, Service.Builder

@Generated public interface ServiceOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       Immutable. The resource name for the service in the format
       `projects/*/locations/*/namespaces/*/services/*`.
       
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Immutable. The resource name for the service in the format
       `projects/*/locations/*/namespaces/*/services/*`.
       
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.
    • getMetadataCount

      int getMetadataCount()
       Optional. Metadata for the service. This data can be consumed by service
       clients.
      
       Restrictions:
      
       *   The entire metadata dictionary may contain up to 2000 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 = 2 [(.google.api.field_behavior) = OPTIONAL];
    • containsMetadata

      boolean containsMetadata(String key)
       Optional. Metadata for the service. This data can be consumed by service
       clients.
      
       Restrictions:
      
       *   The entire metadata dictionary may contain up to 2000 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 = 2 [(.google.api.field_behavior) = OPTIONAL];
    • getMetadata

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

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

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

      String getMetadataOrThrow(String key)
       Optional. Metadata for the service. This data can be consumed by service
       clients.
      
       Restrictions:
      
       *   The entire metadata dictionary may contain up to 2000 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 = 2 [(.google.api.field_behavior) = OPTIONAL];
    • getEndpointsList

      List<Endpoint> getEndpointsList()
       Output only. Endpoints associated with this service. Returned on
       [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
       Control plane clients should use
       [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
       
      repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEndpoints

      Endpoint getEndpoints(int index)
       Output only. Endpoints associated with this service. Returned on
       [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
       Control plane clients should use
       [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
       
      repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEndpointsCount

      int getEndpointsCount()
       Output only. Endpoints associated with this service. Returned on
       [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
       Control plane clients should use
       [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
       
      repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEndpointsOrBuilderList

      List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()
       Output only. Endpoints associated with this service. Returned on
       [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
       Control plane clients should use
       [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
       
      repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEndpointsOrBuilder

      EndpointOrBuilder getEndpointsOrBuilder(int index)
       Output only. Endpoints associated with this service. Returned on
       [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].
       Control plane clients should use
       [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
       
      repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp when the service 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 service 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 service was created.
       
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The timestamp when the service was last updated. Note:
       endpoints being created/deleted/updated within the service are not
       considered service updates for the purpose of this timestamp.
       
      .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 service was last updated. Note:
       endpoints being created/deleted/updated within the service are not
       considered service updates for the purpose of this timestamp.
       
      .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 service was last updated. Note:
       endpoints being created/deleted/updated within the service are not
       considered service updates for the purpose of this timestamp.
       
      .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
       service.
       
      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
       service.
       
      string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.