/*
* 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 ApiOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.apigeeregistry.v1.Api)
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. Creation timestamp.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Creation timestamp.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Creation timestamp.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Last update timestamp.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Last update timestamp.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Last update timestamp.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return The availability.
*/
java.lang.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;
*
* @return The bytes for availability.
*/
com.google.protobuf.ByteString getAvailabilityBytes();
/**
*
*
*
* The recommended version of the API.
* Format: `apis/{api}/versions/{version}`
*
*
* string recommended_version = 7 [(.google.api.resource_reference) = { ... }
*
* @return The recommendedVersion.
*/
java.lang.String getRecommendedVersion();
/**
*
*
*
* The recommended version of the API.
* Format: `apis/{api}/versions/{version}`
*
*
* string recommended_version = 7 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for recommendedVersion.
*/
com.google.protobuf.ByteString getRecommendedVersionBytes();
/**
*
*
*
* The recommended deployment of the API.
* Format: `apis/{api}/deployments/{deployment}`
*
*
* string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
*
* @return The recommendedDeployment.
*/
java.lang.String getRecommendedDeployment();
/**
*
*
*
* The recommended deployment of the API.
* Format: `apis/{api}/deployments/{deployment}`
*
*
* string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for recommendedDeployment.
*/
com.google.protobuf.ByteString getRecommendedDeploymentBytes();
/**
*
*
*
* 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;
*/
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 = 9;
*/
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 = 9;
*/
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 = 9;
*/
/* 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 = 9;
*/
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 = 10;
*/
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 = 10;
*/
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 = 10;
*/
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 = 10;
*/
/* 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 = 10;
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
}