Interface ServiceOrBuilder (2.4.2)

Version 2.4.2

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.5
• 2.2.7

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 goes beyond any these limits will be 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 will be rejected.
• The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns

Type	Description
Map<String,String>

getAnnotationsCount()

public abstract 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 goes beyond any these limits will be 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 will be rejected.
• The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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];

Returns

Type	Description
int

getAnnotationsMap()

public abstract 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 goes beyond any these limits will be 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 will be rejected.
• The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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];

Returns

Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract 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 goes beyond any these limits will be 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 will be rejected.
• The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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];

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getAnnotationsOrThrow(String key)

public abstract 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 goes beyond any these limits will be 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 will be rejected.
• The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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];

Parameter

Name	Description
key	String

Returns

Type	Description
String

getEndpoints(int index)

public abstract Endpoint getEndpoints(int index)

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
index	int

Returns

Type	Description
Endpoint

getEndpointsCount()

public abstract int getEndpointsCount()

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int

getEndpointsList()

public abstract List<Endpoint> getEndpointsList()

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
List<Endpoint>

getEndpointsOrBuilder(int index)

public abstract EndpointOrBuilder getEndpointsOrBuilder(int index)

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
index	int

Returns

Type	Description
EndpointOrBuilder

getEndpointsOrBuilderList()

public abstract List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
List<? extends com.google.cloud.servicedirectory.v1.EndpointOrBuilder>

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for name.