public final class ListCatalogsRequest extends GeneratedMessageV3 implements ListCatalogsRequestOrBuilder
Request for
CatalogService.ListCatalogs
method.
Protobuf type google.cloud.retail.v2.ListCatalogsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListCatalogsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListCatalogsRequest.Builder newBuilder()
newBuilder(ListCatalogsRequest prototype)
public static ListCatalogsRequest.Builder newBuilder(ListCatalogsRequest prototype)
public static ListCatalogsRequest parseDelimitedFrom(InputStream input)
public static ListCatalogsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListCatalogsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListCatalogsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListCatalogsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCatalogsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCatalogsRequest parseFrom(CodedInputStream input)
public static ListCatalogsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCatalogsRequest parseFrom(InputStream input)
public static ListCatalogsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListCatalogsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListCatalogsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListCatalogsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListCatalogsRequest getDefaultInstanceForType()
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
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) = { ... }
| Returns |
| 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListCatalogsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListCatalogsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListCatalogsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListCatalogsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
