Interface ApiOrBuilder (0.14.1)

public interface ApiOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 9;

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()

map<string, string> annotations = 10;

Returns
Type	Description
`int`

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

map<string, string> annotations = 10;

Returns
Type	Description
`Map<String,String>`

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

map<string, string> annotations = 10;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

map<string, string> annotations = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getAvailability()

public abstract String getAvailability()

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Returns
Type	Description
`String`	The availability.

getAvailabilityBytes()

public abstract ByteString getAvailabilityBytes()

string availability = 6;

Returns
Type	Description
`ByteString`	The bytes for availability.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

public abstract String getDescription()

A detailed description.

string description = 3;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A detailed description.

string description = 3;

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Human-meaningful name.

string display_name = 2;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Human-meaningful name.

string display_name = 2;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

map<string, string> labels = 9;

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

map<string, string> labels = 9;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 9;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

map<string, string> labels = 9;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String getName()

Resource name.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getRecommendedDeployment()

public abstract String getRecommendedDeployment()

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Returns
Type	Description
`String`	The recommendedDeployment.

getRecommendedDeploymentBytes()

public abstract ByteString getRecommendedDeploymentBytes()

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Returns
Type	Description
`ByteString`	The bytes for recommendedDeployment.

getRecommendedVersion()

public abstract String getRecommendedVersion()

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Returns
Type	Description
`String`	The recommendedVersion.

getRecommendedVersionBytes()

public abstract ByteString getRecommendedVersionBytes()

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Returns
Type	Description
`ByteString`	The bytes for recommendedVersion.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
Type	Description
`TimestampOrBuilder`

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
Type	Description
`boolean`	Whether the updateTime field is set.