- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ListControlsRequest.Builder extends GeneratedMessageV3.Builder<ListControlsRequest.Builder> implements ListControlsRequestOrBuilder
Request for ListControls method.
Protobuf type google.cloud.retail.v2.ListControlsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListControlsRequest.BuilderImplements
ListControlsRequestOrBuilderStatic 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 |
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 |
clearField(Descriptors.FieldDescriptor field)
public ListControlsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListControlsRequest.Builder |
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.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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 |
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 catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_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 |
getDefaultInstanceForType()
public ListControlsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListControlsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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 catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_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 catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListControlsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListControlsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListControlsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListControlsRequest.Builder |
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 |
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.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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 catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_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 catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_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 |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListControlsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListControlsRequest.Builder |