com.google.cloud.retail.v2alpha

Interface ListCatalogsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListCatalogsRequest, ListCatalogsRequest.Builder

public interface ListCatalogsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getPageSize() Maximum number of [Catalog][google.cloud.retail.v2alpha.Catalog]s to return.
String	getPageToken() A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2alpha.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2alpha.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The account resource name with an associated location.

 If the caller does not have permission to list
 [Catalog][google.cloud.retail.v2alpha.Catalog]s 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) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The account resource name with an associated location.

 If the caller does not have permission to list
 [Catalog][google.cloud.retail.v2alpha.Catalog]s 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) = { ... }

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 Maximum number of [Catalog][google.cloud.retail.v2alpha.Catalog]s 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;

Returns:

The pageSize.

getPageToken

String getPageToken()

 A page token
 [ListCatalogsResponse.next_page_token][google.cloud.retail.v2alpha.ListCatalogsResponse.next_page_token],
 received from a previous
 [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 A page token
 [ListCatalogsResponse.next_page_token][google.cloud.retail.v2alpha.ListCatalogsResponse.next_page_token],
 received from a previous
 [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
 

string page_token = 3;

Returns:

The bytes for pageToken.