Class SetIamPolicyRequest (1.45.0)

public final class SetIamPolicyRequest extends GeneratedMessageV3 implements SetIamPolicyRequestOrBuilder

Request message for SetIamPolicy method.

Protobuf type google.iam.v1.SetIamPolicyRequest

Static Fields

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SetIamPolicyRequest getDefaultInstance()
Returns
Type Description
SetIamPolicyRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SetIamPolicyRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SetIamPolicyRequest getDefaultInstanceForType()
Returns
Type Description
SetIamPolicyRequest

getParserForType()

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

getPolicy()

public Policy getPolicy()

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Policy

The policy.

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyOrBuilder

getResource()

public String getResource()

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

string resource = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

string resource = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for resource.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMaskOrBuilder

hasPolicy()

public boolean hasPolicy()

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the policy field is set.

hasUpdateMask()

public boolean hasUpdateMask()

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
boolean

Whether the updateMask field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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