Class GetPolicyOptions (1.34.1)

public final class GetPolicyOptions extends GeneratedMessageV3 implements GetPolicyOptionsOrBuilder

Encapsulates settings provided to GetIamPolicy.

Protobuf type google.iam.v1.GetPolicyOptions

Static Fields

REQUESTED_POLICY_VERSION_FIELD_NUMBER

public static final int REQUESTED_POLICY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetPolicyOptions getDefaultInstance()
Returns
Type Description
GetPolicyOptions

getDescriptor()

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

newBuilder()

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

newBuilder(GetPolicyOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetPolicyOptions getDefaultInstanceForType()
Returns
Type Description
GetPolicyOptions

getParserForType()

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

getRequestedPolicyVersion()

public int getRequestedPolicyVersion()

Optional. The maximum policy version that will be used to format the policy.

Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.

Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.

The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.

To learn which resources support conditions in their IAM policies, see the IAM documentation.

int32 requested_policy_version = 1;

Returns
Type Description
int

The requestedPolicyVersion.

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 GetPolicyOptions.Builder newBuilderForType()
Returns
Type Description
GetPolicyOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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