Class ListControlsRequest.Builder (0.45.0)

public static final class ListControlsRequest.Builder extends GeneratedMessageV3.Builder<ListControlsRequest.Builder> implements ListControlsRequestOrBuilder

Request for ListControls method.

Protobuf type google.cloud.discoveryengine.v1.ListControlsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListControlsRequest build()
Returns
Type Description
ListControlsRequest

buildPartial()

public ListControlsRequest buildPartial()
Returns
Type Description
ListControlsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListControlsRequest.Builder clearFilter()

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset. Currently this field is unsupported.

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

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListControlsRequest.Builder clearPageSize()

Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

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

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

clearPageToken()

public ListControlsRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

clearParent()

public ListControlsRequest.Builder clearParent()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

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

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListControlsRequest getDefaultInstanceForType()
Returns
Type Description
ListControlsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset. Currently this field is unsupported.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset. Currently this field is unsupported.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed 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 ListControls call. Provide this to retrieve the subsequent page.

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 ListControls call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListControlsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListControlsRequest.Builder setFilter(String value)

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset. Currently this field is unsupported.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListControlsRequest.Builder setFilterBytes(ByteString value)

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset. Currently this field is unsupported.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListControlsRequest.Builder setPageSize(int value)

Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListControlsRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListControlsRequest.Builder setPageTokenBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setParent(String value)

public ListControlsRequest.Builder setParent(String value)

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListControlsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListControlsRequest.Builder setParentBytes(ByteString value)

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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