com.google.cloud.retail.v2

Class ListCatalogsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

com.google.cloud.retail.v2.ListCatalogsRequest.Builder

All Implemented Interfaces:

ListCatalogsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListCatalogsRequest

public static final class ListCatalogsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>
implements ListCatalogsRequestOrBuilder

 Request for
 [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs]
 method.
 

Protobuf type google.cloud.retail.v2.ListCatalogsRequest

Method Summary

Modifier and Type	Method and Description
ListCatalogsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListCatalogsRequest	build()
ListCatalogsRequest	buildPartial()
ListCatalogsRequest.Builder	clear()
ListCatalogsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListCatalogsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListCatalogsRequest.Builder	clearPageSize() Maximum number of [Catalog][google.cloud.retail.v2.Catalog]s to return.
ListCatalogsRequest.Builder	clearPageToken() A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call.
ListCatalogsRequest.Builder	clearParent() Required.
ListCatalogsRequest.Builder	clone()
ListCatalogsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getPageSize() Maximum number of [Catalog][google.cloud.retail.v2.Catalog]s to return.
String	getPageToken() A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListCatalogsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListCatalogsRequest.Builder	mergeFrom(ListCatalogsRequest other)
ListCatalogsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListCatalogsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListCatalogsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListCatalogsRequest.Builder	setPageSize(int value) Maximum number of [Catalog][google.cloud.retail.v2.Catalog]s to return.
ListCatalogsRequest.Builder	setPageToken(String value) A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call.
ListCatalogsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call.
ListCatalogsRequest.Builder	setParent(String value) Required.
ListCatalogsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListCatalogsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListCatalogsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

clear

public ListCatalogsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

getDefaultInstanceForType

public ListCatalogsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListCatalogsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListCatalogsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ListCatalogsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

setField

public ListCatalogsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

clearField

public ListCatalogsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

clearOneof

public ListCatalogsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

setRepeatedField

public ListCatalogsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

addRepeatedField

public ListCatalogsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

mergeFrom

public ListCatalogsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListCatalogsRequest.Builder>

mergeFrom

public ListCatalogsRequest.Builder mergeFrom(ListCatalogsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

mergeFrom

public ListCatalogsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListCatalogsRequest.Builder>

Throws:

IOException

getParent

public String getParent()

 Required. The account resource name with an associated location.

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

Specified by:

getParent in interface ListCatalogsRequestOrBuilder

Returns:

The parent.

getParentBytes

public 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.v2.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) = { ... }

Specified by:

getParentBytes in interface ListCatalogsRequestOrBuilder

Returns:

The bytes for parent.

setParent

public ListCatalogsRequest.Builder setParent(String value)

 Required. The account resource name with an associated location.

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

Parameters:

value - The parent to set.

Returns:

This builder for chaining.

clearParent

public ListCatalogsRequest.Builder clearParent()

 Required. The account resource name with an associated location.

 If the caller does not have permission to list
 [Catalog][google.cloud.retail.v2.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:

This builder for chaining.

setParentBytes

public ListCatalogsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The account resource name with an associated location.

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

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

getPageSize

public int getPageSize()

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

Specified by:

getPageSize in interface ListCatalogsRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListCatalogsRequest.Builder setPageSize(int value)

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

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListCatalogsRequest.Builder clearPageSize()

 Maximum number of [Catalog][google.cloud.retail.v2.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:

This builder for chaining.

getPageToken

public String getPageToken()

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

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

string page_token = 3;

Specified by:

getPageToken in interface ListCatalogsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

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

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

string page_token = 3;

Specified by:

getPageTokenBytes in interface ListCatalogsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListCatalogsRequest.Builder setPageToken(String value)

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

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

string page_token = 3;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListCatalogsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns:

This builder for chaining.

setPageTokenBytes

public ListCatalogsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

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

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

string page_token = 3;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListCatalogsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>

mergeUnknownFields

public final ListCatalogsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListCatalogsRequest.Builder>