Class GetPolicyOptions (1.28.0)

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
TypeDescription
int

Static Methods

getDefaultInstance()

public static GetPolicyOptions getDefaultInstance()
Returns
TypeDescription
GetPolicyOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GetPolicyOptions.Builder newBuilder()
Returns
TypeDescription
GetPolicyOptions.Builder

newBuilder(GetPolicyOptions prototype)

public static GetPolicyOptions.Builder newBuilder(GetPolicyOptions prototype)
Parameter
NameDescription
prototypeGetPolicyOptions
Returns
TypeDescription
GetPolicyOptions.Builder

parseDelimitedFrom(InputStream input)

public static GetPolicyOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GetPolicyOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetPolicyOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetPolicyOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GetPolicyOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GetPolicyOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetPolicyOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetPolicyOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GetPolicyOptions> parser()
Returns
TypeDescription
Parser<GetPolicyOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public GetPolicyOptions getDefaultInstanceForType()
Returns
TypeDescription
GetPolicyOptions

getParserForType()

public Parser<GetPolicyOptions> getParserForType()
Returns
TypeDescription
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
TypeDescription
int

The requestedPolicyVersion.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GetPolicyOptions.Builder newBuilderForType()
Returns
TypeDescription
GetPolicyOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetPolicyOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GetPolicyOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GetPolicyOptions.Builder toBuilder()
Returns
TypeDescription
GetPolicyOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException