com.google.api.services.accesscontextmanager.v1.model.AccessPolicy Maven / Gradle / Ivy
/*
* 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://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.accesscontextmanager.v1.model;
/**
* `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use
* Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely
* pass data within a perimeter). An access policy is globally visible within an organization, and
* the restrictions it specifies apply to all projects within an organization.
*
* 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 Access Context Manager API. For a detailed
* explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class AccessPolicy extends com.google.api.client.json.GenericJson {
/**
* Output only. An opaque identifier for the current version of the `AccessPolicy`. This will
* always be a strongly validated etag, meaning that two Access Policies will be identical if and
* only if their etags are identical. Clients should not expect this to be in any specific format.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* Output only. Identifier. Resource name of the `AccessPolicy`. Format:
* `accessPolicies/{access_policy}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently
* immutable once created. Format: `organizations/{organization_id}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String parent;
/**
* The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where
* its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the
* following behavior: - ServicePerimeter can only restrict projects within `folders/123`. -
* ServicePerimeter within policy A can only reference access levels defined within policy A. -
* Only one policy can include a given scope; thus, attempting to create a second policy which
* includes `folders/123` will result in an error. If no scopes are provided, then any resource
* within the organization can be restricted. Scopes cannot be modified after a policy is created.
* Policies can only have a single scope. Format: list of `folders/{folder_number}` or
* `projects/{project_number}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List scopes;
/**
* Required. Human readable title. Does not affect behavior.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String title;
/**
* Output only. An opaque identifier for the current version of the `AccessPolicy`. This will
* always be a strongly validated etag, meaning that two Access Policies will be identical if and
* only if their etags are identical. Clients should not expect this to be in any specific format.
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* Output only. An opaque identifier for the current version of the `AccessPolicy`. This will
* always be a strongly validated etag, meaning that two Access Policies will be identical if and
* only if their etags are identical. Clients should not expect this to be in any specific format.
* @param etag etag or {@code null} for none
*/
public AccessPolicy setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* Output only. Identifier. Resource name of the `AccessPolicy`. Format:
* `accessPolicies/{access_policy}`
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* Output only. Identifier. Resource name of the `AccessPolicy`. Format:
* `accessPolicies/{access_policy}`
* @param name name or {@code null} for none
*/
public AccessPolicy setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently
* immutable once created. Format: `organizations/{organization_id}`
* @return value or {@code null} for none
*/
public java.lang.String getParent() {
return parent;
}
/**
* Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently
* immutable once created. Format: `organizations/{organization_id}`
* @param parent parent or {@code null} for none
*/
public AccessPolicy setParent(java.lang.String parent) {
this.parent = parent;
return this;
}
/**
* The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where
* its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the
* following behavior: - ServicePerimeter can only restrict projects within `folders/123`. -
* ServicePerimeter within policy A can only reference access levels defined within policy A. -
* Only one policy can include a given scope; thus, attempting to create a second policy which
* includes `folders/123` will result in an error. If no scopes are provided, then any resource
* within the organization can be restricted. Scopes cannot be modified after a policy is created.
* Policies can only have a single scope. Format: list of `folders/{folder_number}` or
* `projects/{project_number}`
* @return value or {@code null} for none
*/
public java.util.List getScopes() {
return scopes;
}
/**
* The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where
* its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the
* following behavior: - ServicePerimeter can only restrict projects within `folders/123`. -
* ServicePerimeter within policy A can only reference access levels defined within policy A. -
* Only one policy can include a given scope; thus, attempting to create a second policy which
* includes `folders/123` will result in an error. If no scopes are provided, then any resource
* within the organization can be restricted. Scopes cannot be modified after a policy is created.
* Policies can only have a single scope. Format: list of `folders/{folder_number}` or
* `projects/{project_number}`
* @param scopes scopes or {@code null} for none
*/
public AccessPolicy setScopes(java.util.List scopes) {
this.scopes = scopes;
return this;
}
/**
* Required. Human readable title. Does not affect behavior.
* @return value or {@code null} for none
*/
public java.lang.String getTitle() {
return title;
}
/**
* Required. Human readable title. Does not affect behavior.
* @param title title or {@code null} for none
*/
public AccessPolicy setTitle(java.lang.String title) {
this.title = title;
return this;
}
@Override
public AccessPolicy set(String fieldName, Object value) {
return (AccessPolicy) super.set(fieldName, value);
}
@Override
public AccessPolicy clone() {
return (AccessPolicy) super.clone();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy