/*
* 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/iam/v2beta/policy.proto
package com.google.iam.v2beta;
public interface PolicyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.iam.v2beta.Policy)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Immutable. The resource name of the `Policy`, which must be unique. Format:
* `policies/{attachment_point}/denypolicies/{policy_id}`
* The attachment point is identified by its URL-encoded full resource name,
* which means that the forward-slash character, `/`, must be written as
* `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`.
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, requests can use the alphanumeric or the numeric ID.
* Responses always contain the numeric ID.
*
*
* string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Immutable. The resource name of the `Policy`, which must be unique. Format:
* `policies/{attachment_point}/denypolicies/{policy_id}`
* The attachment point is identified by its URL-encoded full resource name,
* which means that the forward-slash character, `/`, must be written as
* `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`.
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, requests can use the alphanumeric or the numeric ID.
* Responses always contain the numeric ID.
*
*
* string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Immutable. The globally unique ID of the `Policy`. Assigned automatically when the
* `Policy` is created.
*
*
* string uid = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Immutable. The globally unique ID of the `Policy`. Assigned automatically when the
* `Policy` is created.
*
*
* string uid = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
*
*
* string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The kind.
*/
java.lang.String getKind();
/**
*
*
*
* Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
*
*
* string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for kind.
*/
com.google.protobuf.ByteString getKindBytes();
/**
*
*
*
* A user-specified description of the `Policy`. This value can be up to 63
* characters.
*
*
* string display_name = 4;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* A user-specified description of the `Policy`. This value can be up to 63
* characters.
*
*
* string display_name = 4;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* A key-value map to store arbitrary metadata for the `Policy`. Keys
* can be up to 63 characters. Values can be up to 255 characters.
*
*
* map<string, string> annotations = 5;
*/
int getAnnotationsCount();
/**
*
*
*
* A key-value map to store arbitrary metadata for the `Policy`. Keys
* can be up to 63 characters. Values can be up to 255 characters.
*
*
* map<string, string> annotations = 5;
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* A key-value map to store arbitrary metadata for the `Policy`. Keys
* can be up to 63 characters. Values can be up to 255 characters.
*
*
* map<string, string> annotations = 5;
*/
java.util.Map getAnnotationsMap();
/**
*
*
*
* A key-value map to store arbitrary metadata for the `Policy`. Keys
* can be up to 63 characters. Values can be up to 255 characters.
*
*
* map<string, string> annotations = 5;
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* A key-value map to store arbitrary metadata for the `Policy`. Keys
* can be up to 63 characters. Values can be up to 255 characters.
*
*
* map<string, string> annotations = 5;
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
/**
*
*
*
* An opaque tag that identifies the current version of the `Policy`. IAM uses
* this value to help manage concurrent updates, so they do not cause one
* update to be overwritten by another.
* If this field is present in a [CreatePolicy][] request, the value is
* ignored.
*
*
* string etag = 6;
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* An opaque tag that identifies the current version of the `Policy`. IAM uses
* this value to help manage concurrent updates, so they do not cause one
* update to be overwritten by another.
* If this field is present in a [CreatePolicy][] request, the value is
* ignored.
*
*
* string etag = 6;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Output only. The time when the `Policy` was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the `Policy` was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the `Policy` was created.
*
*
* .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the `Policy` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the `Policy` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time when the `Policy` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
*
*
* .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deleteTime field is set.
*/
boolean hasDeleteTime();
/**
*
*
*
* Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
*
*
* .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deleteTime.
*/
com.google.protobuf.Timestamp getDeleteTime();
/**
*
*
*
* Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
*
*
* .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder();
/**
*
*
*
* A list of rules that specify the behavior of the `Policy`. All of the rules
* should be of the `kind` specified in the `Policy`.
*
*
* repeated .google.iam.v2beta.PolicyRule rules = 10;
*/
java.util.List getRulesList();
/**
*
*
*
* A list of rules that specify the behavior of the `Policy`. All of the rules
* should be of the `kind` specified in the `Policy`.
*
*
* repeated .google.iam.v2beta.PolicyRule rules = 10;
*/
com.google.iam.v2beta.PolicyRule getRules(int index);
/**
*
*
*
* A list of rules that specify the behavior of the `Policy`. All of the rules
* should be of the `kind` specified in the `Policy`.
*
*
* repeated .google.iam.v2beta.PolicyRule rules = 10;
*/
int getRulesCount();
/**
*
*
*
* A list of rules that specify the behavior of the `Policy`. All of the rules
* should be of the `kind` specified in the `Policy`.
*
*
* repeated .google.iam.v2beta.PolicyRule rules = 10;
*/
java.util.List getRulesOrBuilderList();
/**
*
*
*
* A list of rules that specify the behavior of the `Policy`. All of the rules
* should be of the `kind` specified in the `Policy`.
*
*
* repeated .google.iam.v2beta.PolicyRule rules = 10;
*/
com.google.iam.v2beta.PolicyRuleOrBuilder getRulesOrBuilder(int index);
}