Class SearchAllIamPoliciesRequest.Builder (3.41.0)

public static final class SearchAllIamPoliciesRequest.Builder extends GeneratedMessageV3.Builder<SearchAllIamPoliciesRequest.Builder> implements SearchAllIamPoliciesRequestOrBuilder

Search all IAM policies request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchAllIamPoliciesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

build()

public SearchAllIamPoliciesRequest build()
Returns
TypeDescription
SearchAllIamPoliciesRequest

buildPartial()

public SearchAllIamPoliciesRequest buildPartial()
Returns
TypeDescription
SearchAllIamPoliciesRequest

clear()

public SearchAllIamPoliciesRequest.Builder clear()
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchAllIamPoliciesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchAllIamPoliciesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

clearPageSize()

public SearchAllIamPoliciesRequest.Builder clearPageSize()

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

clearPageToken()

public SearchAllIamPoliciesRequest.Builder clearPageToken()

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

clearQuery()

public SearchAllIamPoliciesRequest.Builder clearQuery()

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

clearScope()

public SearchAllIamPoliciesRequest.Builder clearScope()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

clone()

public SearchAllIamPoliciesRequest.Builder clone()
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchAllIamPoliciesRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchAllIamPoliciesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getQuery()

public String getQuery()

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for query.

getScope()

public String getScope()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for scope.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchAllIamPoliciesRequest other)

public SearchAllIamPoliciesRequest.Builder mergeFrom(SearchAllIamPoliciesRequest other)
Parameter
NameDescription
otherSearchAllIamPoliciesRequest
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchAllIamPoliciesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchAllIamPoliciesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchAllIamPoliciesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchAllIamPoliciesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

setPageSize(int value)

public SearchAllIamPoliciesRequest.Builder setPageSize(int value)

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchAllIamPoliciesRequest.Builder setPageToken(String value)

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchAllIamPoliciesRequest.Builder setPageTokenBytes(ByteString value)

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchAllIamPoliciesRequest.Builder setQuery(String value)

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchAllIamPoliciesRequest.Builder setQueryBytes(ByteString value)

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

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

public SearchAllIamPoliciesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides

setScope(String value)

public SearchAllIamPoliciesRequest.Builder setScope(String value)

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The scope to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public SearchAllIamPoliciesRequest.Builder setScopeBytes(ByteString value)

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for scope to set.

Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchAllIamPoliciesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchAllIamPoliciesRequest.Builder
Overrides