/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/apigeeregistry/v1/registry_models.proto
package com.google.cloud.apigeeregistry.v1;
public interface ApiDeploymentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.apigeeregistry.v1.ApiDeployment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Resource name.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Resource name.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Human-meaningful name.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Human-meaningful name.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* A detailed description.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* A detailed description.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* 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];
*
*
* @return The revisionId.
*/
java.lang.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];
*
*
* @return The bytes for revisionId.
*/
com.google.protobuf.ByteString getRevisionIdBytes();
/**
*
*
*
* Output only. Creation timestamp; when the deployment resource was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Creation timestamp; when the deployment resource was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Creation timestamp; when the deployment resource was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Revision creation timestamp; when the represented revision was created.
*
*
*
* .google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the revisionCreateTime field is set.
*/
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];
*
*
* @return The revisionCreateTime.
*/
com.google.protobuf.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];
*
*/
com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the revisionUpdateTime field is set.
*/
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];
*
*
* @return The revisionUpdateTime.
*/
com.google.protobuf.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];
*
*/
com.google.protobuf.TimestampOrBuilder getRevisionUpdateTimeOrBuilder();
/**
*
*
*
* 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) = { ... }
*
* @return The apiSpecRevision.
*/
java.lang.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) = { ... }
*
* @return The bytes for apiSpecRevision.
*/
com.google.protobuf.ByteString getApiSpecRevisionBytes();
/**
*
*
*
* The address where the deployment is serving. Changes to this value will
* update the revision.
*
*
* string endpoint_uri = 9;
*
* @return The endpointUri.
*/
java.lang.String getEndpointUri();
/**
*
*
*
* The address where the deployment is serving. Changes to this value will
* update the revision.
*
*
* string endpoint_uri = 9;
*
* @return The bytes for endpointUri.
*/
com.google.protobuf.ByteString getEndpointUriBytes();
/**
*
*
*
* 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;
*
* @return The externalChannelUri.
*/
java.lang.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;
*
* @return The bytes for externalChannelUri.
*/
com.google.protobuf.ByteString getExternalChannelUriBytes();
/**
*
*
*
* Text briefly identifying the intended audience of the API. Changes to this
* value will not affect the revision.
*
*
* string intended_audience = 11;
*
* @return The intendedAudience.
*/
java.lang.String getIntendedAudience();
/**
*
*
*
* Text briefly identifying the intended audience of the API. Changes to this
* value will not affect the revision.
*
*
* string intended_audience = 11;
*
* @return The bytes for intendedAudience.
*/
com.google.protobuf.ByteString getIntendedAudienceBytes();
/**
*
*
*
* Text briefly describing how to access the endpoint. Changes to this value
* will not affect the revision.
*
*
* string access_guidance = 12;
*
* @return The accessGuidance.
*/
java.lang.String getAccessGuidance();
/**
*
*
*
* Text briefly describing how to access the endpoint. Changes to this value
* will not affect the revision.
*
*
* string access_guidance = 12;
*
* @return The bytes for accessGuidance.
*/
com.google.protobuf.ByteString getAccessGuidanceBytes();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getLabelsOrThrow(java.lang.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;
*/
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;
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
}