Class BatchGetEffectiveIamPoliciesRequest.Builder (3.40.0) 

public static final class BatchGetEffectiveIamPoliciesRequest.Builder extends GeneratedMessageV3.Builder<BatchGetEffectiveIamPoliciesRequest.Builder> implements BatchGetEffectiveIamPoliciesRequestOrBuilder

A request message for AssetService.BatchGetEffectiveIamPolicies.

Protobuf type google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllNames(Iterable<String> values)

public BatchGetEffectiveIamPoliciesRequest.Builder addAllNames(Iterable<String> values)

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
values Iterable<String>

The names to add.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

addNames(String value)

public BatchGetEffectiveIamPoliciesRequest.Builder addNames(String value)

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
value String

The names to add.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

addNamesBytes(ByteString value)

public BatchGetEffectiveIamPoliciesRequest.Builder addNamesBytes(ByteString value)

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
value ByteString

The bytes of the names to add.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchGetEffectiveIamPoliciesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

build()

public BatchGetEffectiveIamPoliciesRequest build()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest

buildPartial()

public BatchGetEffectiveIamPoliciesRequest buildPartial()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest

clear()

public BatchGetEffectiveIamPoliciesRequest.Builder clear()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BatchGetEffectiveIamPoliciesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

clearNames()

public BatchGetEffectiveIamPoliciesRequest.Builder clearNames()

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
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchGetEffectiveIamPoliciesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

clearScope()

public BatchGetEffectiveIamPoliciesRequest.Builder clearScope()

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
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

clone()

public BatchGetEffectiveIamPoliciesRequest.Builder clone()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

getDefaultInstanceForType()

public BatchGetEffectiveIamPoliciesRequest getDefaultInstanceForType()
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchGetEffectiveIamPoliciesRequest other)

public BatchGetEffectiveIamPoliciesRequest.Builder mergeFrom(BatchGetEffectiveIamPoliciesRequest other)
Parameter
Name Description
other BatchGetEffectiveIamPoliciesRequest
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchGetEffectiveIamPoliciesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchGetEffectiveIamPoliciesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchGetEffectiveIamPoliciesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public BatchGetEffectiveIamPoliciesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

setNames(int index, String value)

public BatchGetEffectiveIamPoliciesRequest.Builder setNames(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The names to set.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchGetEffectiveIamPoliciesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides

setScope(String value)

public BatchGetEffectiveIamPoliciesRequest.Builder setScope(String value)

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) = { ... }

Parameter
Name Description
value String

The scope to set.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public BatchGetEffectiveIamPoliciesRequest.Builder setScopeBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for scope to set.
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchGetEffectiveIamPoliciesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchGetEffectiveIamPoliciesRequest.Builder
Overrides