Class ListAccessSummariesRequest.Builder (0.1.0)

public static final class ListAccessSummariesRequest.Builder extends GeneratedMessage.Builder<ListAccessSummariesRequest.Builder> implements ListAccessSummariesRequestOrBuilder

Message for requesting list of AccessSummaries

Protobuf type google.cloud.agentidentity.v1beta.ListAccessSummariesRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListAccessSummariesRequest build()
Returns
Type Description
ListAccessSummariesRequest

buildPartial()

public ListAccessSummariesRequest buildPartial()
Returns
Type Description
ListAccessSummariesRequest

clear()

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

clearFilter()

public ListAccessSummariesRequest.Builder clearFilter()

Optional. Filter string to restrict the results.

Currently supports filtering by workload_id or auth_provider_name. If no filter is provided, returns all access summaries for the requested project and location. Format: workload_id="<value>" or auth_provider_name="<value>"

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

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

clearOrderBy()

public ListAccessSummariesRequest.Builder clearOrderBy()

Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

clearPageSize()

public ListAccessSummariesRequest.Builder clearPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

clearPageToken()

public ListAccessSummariesRequest.Builder clearPageToken()

Optional. A token identifying a page of results the server should return.

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

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

clearParent()

public ListAccessSummariesRequest.Builder clearParent()

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

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

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListAccessSummariesRequest getDefaultInstanceForType()
Returns
Type Description
ListAccessSummariesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter string to restrict the results.

Currently supports filtering by workload_id or auth_provider_name. If no filter is provided, returns all access summaries for the requested project and location. Format: workload_id="<value>" or auth_provider_name="<value>"

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter string to restrict the results.

Currently supports filtering by workload_id or auth_provider_name. If no filter is provided, returns all access summaries for the requested project and location. Format: workload_id="<value>" or auth_provider_name="<value>"

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token identifying a page of results the server should return.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A token identifying a page of results the server should return.

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 the search is performed. Format: projects/{project}/locations/{location}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListAccessSummariesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListAccessSummariesRequest.Builder setFilter(String value)

Optional. Filter string to restrict the results.

Currently supports filtering by workload_id or auth_provider_name. If no filter is provided, returns all access summaries for the requested project and location. Format: workload_id="<value>" or auth_provider_name="<value>"

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListAccessSummariesRequest.Builder setFilterBytes(ByteString value)

Optional. Filter string to restrict the results.

Currently supports filtering by workload_id or auth_provider_name. If no filter is provided, returns all access summaries for the requested project and location. Format: workload_id="<value>" or auth_provider_name="<value>"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListAccessSummariesRequest.Builder setOrderBy(String value)

Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListAccessSummariesRequest.Builder setOrderByBytes(ByteString value)

Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListAccessSummariesRequest.Builder setPageSize(int value)

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListAccessSummariesRequest.Builder setPageToken(String value)

Optional. A token identifying a page of results the server should return.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListAccessSummariesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token identifying a page of results the server should return.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setParent(String value)

public ListAccessSummariesRequest.Builder setParent(String value)

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListAccessSummariesRequest.Builder setParentBytes(ByteString value)

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListAccessSummariesRequest.Builder

This builder for chaining.