public final class AccessPolicy extends GeneratedMessageV3 implements AccessPolicyOrBuilder
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.
Protobuf type google.identity.accesscontextmanager.v1.AccessPolicy
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCOPES_FIELD_NUMBER
public static final int SCOPES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AccessPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AccessPolicy.Builder newBuilder()
newBuilder(AccessPolicy prototype)
public static AccessPolicy.Builder newBuilder(AccessPolicy prototype)
parseDelimitedFrom(InputStream input)
public static AccessPolicy parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AccessPolicy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AccessPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static AccessPolicy parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static AccessPolicy parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AccessPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AccessPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AccessPolicy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Time the AccessPolicy was created in UTC.
.google.protobuf.Timestamp create_time = 4;
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time the AccessPolicy was created in UTC.
.google.protobuf.Timestamp create_time = 4;
getDefaultInstanceForType()
public AccessPolicy getDefaultInstanceForType()
getEtag()
Output only. An opaque identifier for the current version of the
AccessPolicy. This will always be a strongly validated etag, meaning that
two Access Polices will be identical if and only if their etags are
identical. Clients should not expect this to be in any specific format.
string etag = 6;
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Output only. An opaque identifier for the current version of the
AccessPolicy. This will always be a strongly validated etag, meaning that
two Access Polices will be identical if and only if their etags are
identical. Clients should not expect this to be in any specific format.
string etag = 6;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getName()
Output only. Resource name of the AccessPolicy. Format:
accessPolicies/{access_policy}
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Resource name of the AccessPolicy. Format:
accessPolicies/{access_policy}
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParent()
public String getParent()
Required. The parent of this AccessPolicy in the Cloud Resource
Hierarchy. Currently immutable once created. Format:
organizations/{organization_id}
string parent = 2;
| Returns |
|---|
| Type | Description |
String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The parent of this AccessPolicy in the Cloud Resource
Hierarchy. Currently immutable once created. Format:
organizations/{organization_id}
string parent = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
getParserForType()
public Parser<AccessPolicy> getParserForType()
Overrides
getScopes(int index)
public String getScopes(int index)
The scopes of a policy define which resources an ACM policy can restrict,
and where ACM resources can be referenced.
For example, a policy with scopes=["folders/123"] has the following
behavior:
- vpcsc perimeters can only restrict projects within folders/123
- access levels can only be referenced by resources within folders/123.
If empty, there are no limitations on which resources can be restricted by
an ACM policy, and there are no limitations on where ACM resources can be
referenced.
Only one policy can include a given scope (attempting to create a second
policy which includes "folders/123" will result in an error).
Currently, scopes cannot be modified after a policy is created.
Currently, policies can only have a single scope.
Format: list of
folders/{folder_number} or projects/{project_number}
repeated string scopes = 7;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The scopes at the given index.
|
getScopesBytes(int index)
public ByteString getScopesBytes(int index)
The scopes of a policy define which resources an ACM policy can restrict,
and where ACM resources can be referenced.
For example, a policy with scopes=["folders/123"] has the following
behavior:
- vpcsc perimeters can only restrict projects within folders/123
- access levels can only be referenced by resources within folders/123.
If empty, there are no limitations on which resources can be restricted by
an ACM policy, and there are no limitations on where ACM resources can be
referenced.
Only one policy can include a given scope (attempting to create a second
policy which includes "folders/123" will result in an error).
Currently, scopes cannot be modified after a policy is created.
Currently, policies can only have a single scope.
Format: list of
folders/{folder_number} or projects/{project_number}
repeated string scopes = 7;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the scopes at the given index.
|
getScopesCount()
public int getScopesCount()
The scopes of a policy define which resources an ACM policy can restrict,
and where ACM resources can be referenced.
For example, a policy with scopes=["folders/123"] has the following
behavior:
- vpcsc perimeters can only restrict projects within folders/123
- access levels can only be referenced by resources within folders/123.
If empty, there are no limitations on which resources can be restricted by
an ACM policy, and there are no limitations on where ACM resources can be
referenced.
Only one policy can include a given scope (attempting to create a second
policy which includes "folders/123" will result in an error).
Currently, scopes cannot be modified after a policy is created.
Currently, policies can only have a single scope.
Format: list of
folders/{folder_number} or projects/{project_number}
repeated string scopes = 7;
| Returns |
|---|
| Type | Description |
int | The count of scopes.
|
getScopesList()
public ProtocolStringList getScopesList()
The scopes of a policy define which resources an ACM policy can restrict,
and where ACM resources can be referenced.
For example, a policy with scopes=["folders/123"] has the following
behavior:
- vpcsc perimeters can only restrict projects within folders/123
- access levels can only be referenced by resources within folders/123.
If empty, there are no limitations on which resources can be restricted by
an ACM policy, and there are no limitations on where ACM resources can be
referenced.
Only one policy can include a given scope (attempting to create a second
policy which includes "folders/123" will result in an error).
Currently, scopes cannot be modified after a policy is created.
Currently, policies can only have a single scope.
Format: list of
folders/{folder_number} or projects/{project_number}
repeated string scopes = 7;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getTitle()
Required. Human readable title. Does not affect behavior.
string title = 3;
| Returns |
|---|
| Type | Description |
String | The title.
|
getTitleBytes()
public ByteString getTitleBytes()
Required. Human readable title. Does not affect behavior.
string title = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for title.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time the AccessPolicy was updated in UTC.
.google.protobuf.Timestamp update_time = 5;
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time the AccessPolicy was updated in UTC.
.google.protobuf.Timestamp update_time = 5;
hasCreateTime()
public boolean hasCreateTime()
Output only. Time the AccessPolicy was created in UTC.
.google.protobuf.Timestamp create_time = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time the AccessPolicy was updated in UTC.
.google.protobuf.Timestamp update_time = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AccessPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AccessPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AccessPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
