- 0.51.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.1
- 0.2.2
- 0.1.1
public interface ApiDeploymentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 = 15;
| 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 = 14;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAccessGuidance()
public abstract String getAccessGuidance()Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
string access_guidance = 12;
| Returns | |
|---|---|
| Type | Description |
String | The accessGuidance. |
getAccessGuidanceBytes()
public abstract ByteString getAccessGuidanceBytes()Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
string access_guidance = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for accessGuidance. |
getAnnotations()
public abstract Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getAnnotationsCount()
public abstract int getAnnotationsCount()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 = 15;
| Returns | |
|---|---|
| Type | Description |
int | |
getAnnotationsMap()
public abstract Map<String,String> getAnnotationsMap()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 = 15;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getAnnotationsOrDefault(String key, String defaultValue)
public abstract String getAnnotationsOrDefault(String key, String defaultValue)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 = 15;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getAnnotationsOrThrow(String key)
public abstract String getAnnotationsOrThrow(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 = 15;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getApiSpecRevision()
public abstract String getApiSpecRevision() The full resource name (including revision ID) of the spec of the API being
served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The apiSpecRevision. |
getApiSpecRevisionBytes()
public abstract ByteString getApiSpecRevisionBytes() The full resource name (including revision ID) of the spec of the API being
served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for apiSpecRevision. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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. |
getEndpointUri()
public abstract String getEndpointUri()The address where the deployment is serving. Changes to this value will update the revision.
string endpoint_uri = 9;
| Returns | |
|---|---|
| Type | Description |
String | The endpointUri. |
getEndpointUriBytes()
public abstract ByteString getEndpointUriBytes()The address where the deployment is serving. Changes to this value will update the revision.
string endpoint_uri = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for endpointUri. |
getExternalChannelUri()
public abstract String getExternalChannelUri()The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
string external_channel_uri = 10;
| Returns | |
|---|---|
| Type | Description |
String | The externalChannelUri. |
getExternalChannelUriBytes()
public abstract ByteString getExternalChannelUriBytes()The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
string external_channel_uri = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for externalChannelUri. |
getIntendedAudience()
public abstract String getIntendedAudience()Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
string intended_audience = 11;
| Returns | |
|---|---|
| Type | Description |
String | The intendedAudience. |
getIntendedAudienceBytes()
public abstract ByteString getIntendedAudienceBytes()Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
string intended_audience = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for intendedAudience. |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract int getLabelsCount() 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 = 14;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public abstract Map<String,String> getLabelsMap() 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 = 14;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue) 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 = 14;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(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 = 14;
| 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. |
getRevisionCreateTime()
public abstract Timestamp getRevisionCreateTime()Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The revisionCreateTime. |
getRevisionCreateTimeOrBuilder()
public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getRevisionId()
public abstract String getRevisionId()Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The revisionId. |
getRevisionIdBytes()
public abstract ByteString getRevisionIdBytes()Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for revisionId. |
getRevisionUpdateTime()
public abstract Timestamp getRevisionUpdateTime()Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The revisionUpdateTime. |
getRevisionUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getRevisionUpdateTimeOrBuilder()Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasRevisionCreateTime()
public abstract boolean hasRevisionCreateTime()Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the revisionCreateTime field is set. |
hasRevisionUpdateTime()
public abstract boolean hasRevisionUpdateTime()Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the revisionUpdateTime field is set. |