public static final class ListCatalogsRequest.Builder extends GeneratedMessageV3.Builder<ListCatalogsRequest.Builder> implements ListCatalogsRequestOrBuilder
Request for
CatalogService.ListCatalogs
method.
Protobuf type google.cloud.retail.v2.ListCatalogsRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListCatalogsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public ListCatalogsRequest build()
Returns
buildPartial()
public ListCatalogsRequest buildPartial()
Returns
clear()
public ListCatalogsRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public ListCatalogsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ListCatalogsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearPageSize()
public ListCatalogsRequest.Builder clearPageSize()
Maximum number of Catalogs to return. If
unspecified, defaults to 50. The maximum allowed value is 1000. Values
above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 2;
clearPageToken()
public ListCatalogsRequest.Builder clearPageToken()
A page token
ListCatalogsResponse.next_page_token,
received from a previous
CatalogService.ListCatalogs
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
CatalogService.ListCatalogs
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
clearParent()
public ListCatalogsRequest.Builder clearParent()
Required. The account resource name with an associated location.
If the caller does not have permission to list
Catalogs under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clone()
public ListCatalogsRequest.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public ListCatalogsRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getPageSize()
Maximum number of Catalogs to return. If
unspecified, defaults to 50. The maximum allowed value is 1000. Values
above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 2;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token
ListCatalogsResponse.next_page_token,
received from a previous
CatalogService.ListCatalogs
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
CatalogService.ListCatalogs
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token
ListCatalogsResponse.next_page_token,
received from a previous
CatalogService.ListCatalogs
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
CatalogService.ListCatalogs
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
getParent()
public String getParent()
Required. The account resource name with an associated location.
If the caller does not have permission to list
Catalogs under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The account resource name with an associated location.
If the caller does not have permission to list
Catalogs under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(ListCatalogsRequest other)
public ListCatalogsRequest.Builder mergeFrom(ListCatalogsRequest other)
Parameter
Returns
public ListCatalogsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ListCatalogsRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListCatalogsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ListCatalogsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setPageSize(int value)
public ListCatalogsRequest.Builder setPageSize(int value)
Maximum number of Catalogs to return. If
unspecified, defaults to 50. The maximum allowed value is 1000. Values
above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 2;
| Name | Description |
| value | int
The pageSize to set.
|
Returns
setPageToken(String value)
public ListCatalogsRequest.Builder setPageToken(String value)
A page token
ListCatalogsResponse.next_page_token,
received from a previous
CatalogService.ListCatalogs
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
CatalogService.ListCatalogs
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
| Name | Description |
| value | String
The pageToken to set.
|
Returns
setPageTokenBytes(ByteString value)
public ListCatalogsRequest.Builder setPageTokenBytes(ByteString value)
A page token
ListCatalogsResponse.next_page_token,
received from a previous
CatalogService.ListCatalogs
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
CatalogService.ListCatalogs
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
| Name | Description |
| value | ByteString
The bytes for pageToken to set.
|
Returns
setParent(String value)
public ListCatalogsRequest.Builder setParent(String value)
Required. The account resource name with an associated location.
If the caller does not have permission to list
Catalogs under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | String
The parent to set.
|
Returns
setParentBytes(ByteString value)
public ListCatalogsRequest.Builder setParentBytes(ByteString value)
Required. The account resource name with an associated location.
If the caller does not have permission to list
Catalogs under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | ByteString
The bytes for parent to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListCatalogsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ListCatalogsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
