Class BatchGetEffectiveIamPoliciesRequest (3.47.0)

public final class BatchGetEffectiveIamPoliciesRequest extends GeneratedMessageV3 implements BatchGetEffectiveIamPoliciesRequestOrBuilder

A request message for AssetService.BatchGetEffectiveIamPolicies.

Protobuf type google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest

Inheritance

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

Static Fields

NAMES_FIELD_NUMBER

public static final int NAMES_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchGetEffectiveIamPoliciesRequest getDefaultInstance()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchGetEffectiveIamPoliciesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchGetEffectiveIamPoliciesRequest getDefaultInstanceForType()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest

getNames(int index)

public String getNames(int index)

Required. The names refer to the full_resource_names of the asset types supported by search APIs. A maximum of 20 resources' effective policies can be retrieved in a batch.

repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The names at the given index.

getNamesBytes(int index)

public ByteString getNamesBytes(int index)

Required. The names refer to the full_resource_names of the asset types supported by search APIs. A maximum of 20 resources' effective policies can be retrieved in a batch.

repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the names at the given index.

getNamesCount()

public int getNamesCount()

Required. The names refer to the full_resource_names of the asset types supported by search APIs. A maximum of 20 resources' effective policies can be retrieved in a batch.

repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of names.

getNamesList()

public ProtocolStringList getNamesList()

Required. The names refer to the full_resource_names of the asset types supported by search APIs. A maximum of 20 resources' effective policies can be retrieved in a batch.

repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the names.

getParserForType()

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

getScope()

public String getScope()

Required. Only IAM policies on or below the scope will be returned.

This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").

To know how to get organization ID, visit here .

To know how to get folder or project ID, visit here .

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

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. Only IAM policies on or below the scope will be returned.

This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").

To know how to get organization ID, visit here .

To know how to get folder or project ID, visit here .

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

Returns
Type Description
ByteString

The bytes for scope.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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