All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.services.compute.model.Policy Maven / Gradle / Ivy

There is a newer version: v1-rev20241105-2.0.0
Show newest version
/*
 * 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: 2017-02-15 17:18:02 UTC)
 * on 2017-08-07 at 18:49:37 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.compute.model;

/**
 * Defines an Identity and Access Management (IAM) policy. It is used to specify access control
 * policies for Cloud Platform resources.
 *
 * A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`,
 * where the members can be user accounts, Google groups, Google domains, and service accounts. A
 * `role` is a named list of permissions defined by IAM.
 *
 * **Example**
 *
 * { "bindings": [ { "role": "roles/owner", "members": [ "user:[email protected]",
 * "group:[email protected]", "domain:google.com", "serviceAccount:my-other-
 * [email protected]", ] }, { "role": "roles/viewer", "members":
 * ["user:[email protected]"] } ] }
 *
 * For a description of IAM and its features, see the [IAM developer's
 * guide](https://cloud.google.com/iam).
 *
 * 

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 Compute Engine 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; static { // hack to force ProGuard to consider AuditConfig 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(AuditConfig.class); } /** * Associates a list of `members` to a `role`. `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 * blindly. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String etag; /** * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.Boolean iamOwned; /** * If more than one rule is specified, the rules are applied in the following manner: - All * matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is * denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or * more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.util.List rules; /** * Version of the `Policy`. The default version is 0. * 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`. `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`. `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 * blindly. * @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 * blindly. * @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 * blindly. * @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 * blindly. * @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; } /** * @return value or {@code null} for none */ public java.lang.Boolean getIamOwned() { return iamOwned; } /** * @param iamOwned iamOwned or {@code null} for none */ public Policy setIamOwned(java.lang.Boolean iamOwned) { this.iamOwned = iamOwned; return this; } /** * If more than one rule is specified, the rules are applied in the following manner: - All * matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is * denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or * more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. * @return value or {@code null} for none */ public java.util.List getRules() { return rules; } /** * If more than one rule is specified, the rules are applied in the following manner: - All * matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is * denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or * more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. * @param rules rules or {@code null} for none */ public Policy setRules(java.util.List rules) { this.rules = rules; return this; } /** * Version of the `Policy`. The default version is 0. * @return value or {@code null} for none */ public java.lang.Integer getVersion() { return version; } /** * Version of the `Policy`. The default version is 0. * @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