com.google.api.services.run.v1alpha1.model.Policy Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* 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
*
* http://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.
*/
/*
* This code was generated by https://code.google.com/p/google-apis-client-generator/
* (build: 2018-10-08 17:45:39 UTC)
* on 2019-11-08 at 00:46:02 UTC
* Modify at your own risk.
*/
package com.google.api.services.run.v1alpha1.model;
/**
* Defines an Identity and Access Management (IAM) policy. It is used to specify access control
* policies for Cloud Platform resources.
*
* A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single
* `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G
* Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A
* `binding` can optionally specify a `condition`, which is a logic expression that further
* constrains the role binding based on attributes about the request and/or target resource.
*
* **JSON Example**
*
* { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin",
* "members": [ "user:[email protected]", "group:[email protected]",
* "domain:google.com", "serviceAccount:[email protected]"
* ] }, { "role": "roles/resourcemanager.organizationViewer",
* "members": ["user:[email protected]"], "condition": { "title": "expirable
* access", "description": "Does not grant access after Sep 2020",
* "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", }
* } ] }
*
* **YAML Example**
*
* bindings: - members: - user:[email protected] - group:[email protected]
* - domain:google.com - serviceAccount:[email protected] role:
* roles/resourcemanager.organizationAdmin - members: - user:[email protected] role:
* roles/resourcemanager.organizationViewer condition: title: expirable access
* description: Does not grant access after Sep 2020 expression: request.time <
* timestamp('2020-10-01T00:00:00.000Z')
*
* For a description of IAM and its features, see the [IAM developer's
* guide](https://cloud.google.com/iam/docs).
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Cloud Run API. For a detailed explanation see:
* http://code.google.com/p/google-http-java-client/wiki/JSON
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class Policy extends com.google.api.client.json.GenericJson {
/**
* Specifies cloud audit logging configuration for this policy.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List auditConfigs;
/**
* Associates a list of `members` to a `role`. Optionally may specify a `condition` that
* determines when binding is in effect. `bindings` with no members will result in an error.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List bindings;
static {
// hack to force ProGuard to consider Binding used, since otherwise it would be stripped out
// see http://code.google.com/p/google-api-java-client/issues/detail?id=528
com.google.api.client.util.Data.nullOf(Binding.class);
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates
* of a policy from overwriting each other. It is strongly suggested that systems make use of the
* `etag` in the read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected
* to put that etag in the request to `setIamPolicy` to ensure that their change will be applied
* to the same version of the policy.
*
* If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is
* overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail
* even if either of incoming or stored policy does not meet the version requirements.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* Specifies the format of the policy.
*
* Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.
*
* Operations affecting conditional bindings must specify version 3. This can be either setting a
* conditional policy, modifying a conditional binding, or removing a conditional binding from the
* stored conditional policy. Operations on non-conditional policies may specify any valid value
* or leave the field unset.
*
* If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the
* incoming and/or stored policy is skipped.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer version;
/**
* Specifies cloud audit logging configuration for this policy.
* @return value or {@code null} for none
*/
public java.util.List getAuditConfigs() {
return auditConfigs;
}
/**
* Specifies cloud audit logging configuration for this policy.
* @param auditConfigs auditConfigs or {@code null} for none
*/
public Policy setAuditConfigs(java.util.List auditConfigs) {
this.auditConfigs = auditConfigs;
return this;
}
/**
* Associates a list of `members` to a `role`. Optionally may specify a `condition` that
* determines when binding is in effect. `bindings` with no members will result in an error.
* @return value or {@code null} for none
*/
public java.util.List getBindings() {
return bindings;
}
/**
* Associates a list of `members` to a `role`. Optionally may specify a `condition` that
* determines when binding is in effect. `bindings` with no members will result in an error.
* @param bindings bindings or {@code null} for none
*/
public Policy setBindings(java.util.List bindings) {
this.bindings = bindings;
return this;
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates
* of a policy from overwriting each other. It is strongly suggested that systems make use of the
* `etag` in the read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected
* to put that etag in the request to `setIamPolicy` to ensure that their change will be applied
* to the same version of the policy.
*
* If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is
* overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail
* even if either of incoming or stored policy does not meet the version requirements.
* @see #decodeEtag()
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates
* of a policy from overwriting each other. It is strongly suggested that systems make use of the
* `etag` in the read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected
* to put that etag in the request to `setIamPolicy` to ensure that their change will be applied
* to the same version of the policy.
*
* If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is
* overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail
* even if either of incoming or stored policy does not meet the version requirements.
* @see #getEtag()
* @return Base64 decoded value or {@code null} for none
*
* @since 1.14
*/
public byte[] decodeEtag() {
return com.google.api.client.util.Base64.decodeBase64(etag);
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates
* of a policy from overwriting each other. It is strongly suggested that systems make use of the
* `etag` in the read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected
* to put that etag in the request to `setIamPolicy` to ensure that their change will be applied
* to the same version of the policy.
*
* If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is
* overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail
* even if either of incoming or stored policy does not meet the version requirements.
* @see #encodeEtag()
* @param etag etag or {@code null} for none
*/
public Policy setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates
* of a policy from overwriting each other. It is strongly suggested that systems make use of the
* `etag` in the read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected
* to put that etag in the request to `setIamPolicy` to ensure that their change will be applied
* to the same version of the policy.
*
* If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is
* overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail
* even if either of incoming or stored policy does not meet the version requirements.
* @see #setEtag()
*
*
* The value is encoded Base64 or {@code null} for none.
*
*
* @since 1.14
*/
public Policy encodeEtag(byte[] etag) {
this.etag = com.google.api.client.util.Base64.encodeBase64URLSafeString(etag);
return this;
}
/**
* Specifies the format of the policy.
*
* Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.
*
* Operations affecting conditional bindings must specify version 3. This can be either setting a
* conditional policy, modifying a conditional binding, or removing a conditional binding from the
* stored conditional policy. Operations on non-conditional policies may specify any valid value
* or leave the field unset.
*
* If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the
* incoming and/or stored policy is skipped.
* @return value or {@code null} for none
*/
public java.lang.Integer getVersion() {
return version;
}
/**
* Specifies the format of the policy.
*
* Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.
*
* Operations affecting conditional bindings must specify version 3. This can be either setting a
* conditional policy, modifying a conditional binding, or removing a conditional binding from the
* stored conditional policy. Operations on non-conditional policies may specify any valid value
* or leave the field unset.
*
* If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the
* incoming and/or stored policy is skipped.
* @param version version or {@code null} for none
*/
public Policy setVersion(java.lang.Integer version) {
this.version = version;
return this;
}
@Override
public Policy set(String fieldName, Object value) {
return (Policy) super.set(fieldName, value);
}
@Override
public Policy clone() {
return (Policy) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy