Package com.google.cloud.servicedirectory.v1

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.

    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. Annotations for the service. This data can be consumed by service
 clients.

 Restrictions:

 *   The entire annotations dictionary may contain up to 2000 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsAnnotations

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

 Restrictions:

 *   The entire annotations dictionary may contain up to 2000 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotations

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

    • getAnnotationsMap

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

 Restrictions:

 *   The entire annotations dictionary may contain up to 2000 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrDefault

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

 Restrictions:

 *   The entire annotations dictionary may contain up to 2000 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrThrow

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

 Restrictions:

 *   The entire annotations dictionary may contain up to 2000 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getEndpointsList

      List<Endpoint> getEndpointsList()
       Output only. Endpoints associated with this service. Returned on
 [LookupService.ResolveService][google.cloud.servicedirectory.v1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints].
      repeated .google.cloud.servicedirectory.v1.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.v1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints].
      repeated .google.cloud.servicedirectory.v1.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.v1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints].
      repeated .google.cloud.servicedirectory.v1.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.v1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints].
      repeated .google.cloud.servicedirectory.v1.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.v1.LookupService.ResolveService].
 Control plane clients should use
 [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1.RegistrationService.ListEndpoints].
      repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUid

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

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. The globally unique identifier of the service in the UUID4
 format.
      string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.