Class PrincipalAccessBoundaryPolicyRule (1.52.0) 

public final class PrincipalAccessBoundaryPolicyRule extends GeneratedMessageV3 implements PrincipalAccessBoundaryPolicyRuleOrBuilder

Principal access boundary policy rule that defines the resource boundary.

Protobuf type google.iam.v3.PrincipalAccessBoundaryPolicyRule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PrincipalAccessBoundaryPolicyRule

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EFFECT_FIELD_NUMBER

public static final int EFFECT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrincipalAccessBoundaryPolicyRule getDefaultInstance()
Returns
Type Description
PrincipalAccessBoundaryPolicyRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PrincipalAccessBoundaryPolicyRule.Builder newBuilder()
Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Builder

newBuilder(PrincipalAccessBoundaryPolicyRule prototype)

public static PrincipalAccessBoundaryPolicyRule.Builder newBuilder(PrincipalAccessBoundaryPolicyRule prototype)
Parameter
Name Description
prototype PrincipalAccessBoundaryPolicyRule
Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Builder

parseDelimitedFrom(InputStream input)

public static PrincipalAccessBoundaryPolicyRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PrincipalAccessBoundaryPolicyRule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PrincipalAccessBoundaryPolicyRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PrincipalAccessBoundaryPolicyRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PrincipalAccessBoundaryPolicyRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PrincipalAccessBoundaryPolicyRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PrincipalAccessBoundaryPolicyRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrincipalAccessBoundaryPolicyRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PrincipalAccessBoundaryPolicyRule> parser()
Returns
Type Description
Parser<PrincipalAccessBoundaryPolicyRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PrincipalAccessBoundaryPolicyRule getDefaultInstanceForType()
Returns
Type Description
PrincipalAccessBoundaryPolicyRule

getDescription()

public String getDescription()

Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEffect()

public PrincipalAccessBoundaryPolicyRule.Effect getEffect()

Required. The access relationship of principals to the resources in this rule.

.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Effect

The effect.

getEffectValue()

public int getEffectValue()

Required. The access relationship of principals to the resources in this rule.

.google.iam.v3.PrincipalAccessBoundaryPolicyRule.Effect effect = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for effect.

getParserForType()

public Parser<PrincipalAccessBoundaryPolicyRule> getParserForType()
Returns
Type Description
Parser<PrincipalAccessBoundaryPolicyRule>
Overrides

getResources(int index)

public String getResources(int index)

Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.

repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The resources at the given index.

getResourcesBytes(int index)

public ByteString getResourcesBytes(int index)

Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.

repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the resources at the given index.

getResourcesCount()

public int getResourcesCount()

Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.

repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of resources.

getResourcesList()

public ProtocolStringList getResourcesList()

Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.

repeated string resources = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the resources.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrincipalAccessBoundaryPolicyRule.Builder newBuilderForType()
Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PrincipalAccessBoundaryPolicyRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PrincipalAccessBoundaryPolicyRule.Builder toBuilder()
Returns
Type Description
PrincipalAccessBoundaryPolicyRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException