Class SearchTargetPolicyBindingsRequest.Builder (1.67.0) 

public static final class SearchTargetPolicyBindingsRequest.Builder extends GeneratedMessage.Builder<SearchTargetPolicyBindingsRequest.Builder> implements SearchTargetPolicyBindingsRequestOrBuilder

Request message for SearchTargetPolicyBindings method.

Protobuf type google.iam.v3beta.SearchTargetPolicyBindingsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchTargetPolicyBindingsRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public SearchTargetPolicyBindingsRequest build()
Returns
Type Description
SearchTargetPolicyBindingsRequest

buildPartial()

public SearchTargetPolicyBindingsRequest buildPartial()
Returns
Type Description
SearchTargetPolicyBindingsRequest

clear()

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

clearFilter()

public SearchTargetPolicyBindingsRequest.Builder clearFilter()

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

string filter = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

clearPageSize()

public SearchTargetPolicyBindingsRequest.Builder clearPageSize()

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

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

Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchTargetPolicyBindingsRequest.Builder clearPageToken()

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

clearParent()

public SearchTargetPolicyBindingsRequest.Builder clearParent()

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}

string parent = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

clearTarget()

public SearchTargetPolicyBindingsRequest.Builder clearTarget()

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}

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

Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchTargetPolicyBindingsRequest getDefaultInstanceForType()
Returns
Type Description
SearchTargetPolicyBindingsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

string filter = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

string filter = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}

string parent = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}

string parent = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getTarget()

public String getTarget()

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}

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

Returns
Type Description
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}

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

Returns
Type Description
ByteString

The bytes for target.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchTargetPolicyBindingsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public SearchTargetPolicyBindingsRequest.Builder setFilter(String value)

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

string filter = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SearchTargetPolicyBindingsRequest.Builder setFilterBytes(ByteString value)

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

string filter = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchTargetPolicyBindingsRequest.Builder setPageSize(int value)

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchTargetPolicyBindingsRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchTargetPolicyBindingsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setParent(String value)

public SearchTargetPolicyBindingsRequest.Builder setParent(String value)

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}

string parent = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchTargetPolicyBindingsRequest.Builder setParentBytes(ByteString value)

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}

string parent = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setTarget(String value)

public SearchTargetPolicyBindingsRequest.Builder setTarget(String value)

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}

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

Parameter
Name Description
value String

The target to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public SearchTargetPolicyBindingsRequest.Builder setTargetBytes(ByteString value)

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}

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

Parameter
Name Description
value ByteString

The bytes for target to set.
Returns
Type Description
SearchTargetPolicyBindingsRequest.Builder

This builder for chaining.