/*
* 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/api/apikeys/v2/resources.proto
package com.google.api.apikeys.v2;
public interface KeyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.api.apikeys.v2.Key)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name of the key.
* The `name` has the form:
* `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`.
* For example:
* `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2`
* NOTE: Key is a global resource; hence the only supported value for
* location is `global`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name of the key.
* The `name` has the form:
* `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`.
* For example:
* `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2`
* NOTE: Key is a global resource; hence the only supported value for
* location is `global`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Unique id in UUID4 format.
*
*
* string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Unique id in UUID4 format.
*
*
* string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Human-readable display name of this key that you can modify.
* The maximum length is 63 characters.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Human-readable display name of this key that you can modify.
* The maximum length is 63 characters.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Output only. An encrypted and signed value held by this key.
* This field can be accessed only through the `GetKeyString` method.
*
*
* string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The keyString.
*/
java.lang.String getKeyString();
/**
*
*
*
* Output only. An encrypted and signed value held by this key.
* This field can be accessed only through the `GetKeyString` method.
*
*
* string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for keyString.
*/
com.google.protobuf.ByteString getKeyStringBytes();
/**
*
*
*
* Output only. A timestamp identifying the time this key was originally
* created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. A timestamp identifying the time this key was originally
* created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. A timestamp identifying the time this key was originally
* created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. A timestamp identifying the time this key was last
* updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. A timestamp identifying the time this key was last
* updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. A timestamp identifying the time this key was last
* updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. A timestamp when this key was deleted. If the resource is not deleted,
* this must be empty.
*
*
* .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deleteTime field is set.
*/
boolean hasDeleteTime();
/**
*
*
*
* Output only. A timestamp when this key was deleted. If the resource is not deleted,
* this must be empty.
*
*
* .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deleteTime.
*/
com.google.protobuf.Timestamp getDeleteTime();
/**
*
*
*
* Output only. A timestamp when this key was deleted. If the resource is not deleted,
* this must be empty.
*
*
* .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder();
/**
*
*
*
* Annotations is an unstructured key-value map stored with a policy that
* may be set by external tools to store and retrieve arbitrary metadata.
* They are not queryable and should be preserved when modifying objects.
*
*
* map<string, string> annotations = 8;
*/
int getAnnotationsCount();
/**
*
*
*
* Annotations is an unstructured key-value map stored with a policy that
* may be set by external tools to store and retrieve arbitrary metadata.
* They are not queryable and should be preserved when modifying objects.
*
*
* map<string, string> annotations = 8;
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* Annotations is an unstructured key-value map stored with a policy that
* may be set by external tools to store and retrieve arbitrary metadata.
* They are not queryable and should be preserved when modifying objects.
*
*
* map<string, string> annotations = 8;
*/
java.util.Map getAnnotationsMap();
/**
*
*
*
* Annotations is an unstructured key-value map stored with a policy that
* may be set by external tools to store and retrieve arbitrary metadata.
* They are not queryable and should be preserved when modifying objects.
*
*
* map<string, string> annotations = 8;
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Annotations is an unstructured key-value map stored with a policy that
* may be set by external tools to store and retrieve arbitrary metadata.
* They are not queryable and should be preserved when modifying objects.
*
*
* map<string, string> annotations = 8;
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
/**
*
*
*
* Key restrictions.
*
*
* .google.api.apikeys.v2.Restrictions restrictions = 9;
*
* @return Whether the restrictions field is set.
*/
boolean hasRestrictions();
/**
*
*
*
* Key restrictions.
*
*
* .google.api.apikeys.v2.Restrictions restrictions = 9;
*
* @return The restrictions.
*/
com.google.api.apikeys.v2.Restrictions getRestrictions();
/**
*
*
*
* Key restrictions.
*
*
* .google.api.apikeys.v2.Restrictions restrictions = 9;
*/
com.google.api.apikeys.v2.RestrictionsOrBuilder getRestrictionsOrBuilder();
/**
*
*
*
* Output only. A checksum computed by the server based on the current value of the Key
* resource. This may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* See https://google.aip.dev/154.
*
*
* string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* Output only. A checksum computed by the server based on the current value of the Key
* resource. This may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* See https://google.aip.dev/154.
*
*
* string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
}