Class SearchProductsRequest.Builder (0.23.0)

public static final class SearchProductsRequest.Builder extends GeneratedMessageV3.Builder<SearchProductsRequest.Builder> implements SearchProductsRequestOrBuilder

Request message for PrivateCatalog.SearchProducts.

Protobuf type google.cloud.privatecatalog.v1beta1.SearchProductsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

build()

public SearchProductsRequest build()
Returns
TypeDescription
SearchProductsRequest

buildPartial()

public SearchProductsRequest buildPartial()
Returns
TypeDescription
SearchProductsRequest

clear()

public SearchProductsRequest.Builder clear()
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

clearPageSize()

public SearchProductsRequest.Builder clearPageSize()

The maximum number of entries that are requested.

int32 page_size = 3;

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchProductsRequest.Builder clearPageToken()

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

string page_token = 4;

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

clearQuery()

public SearchProductsRequest.Builder clearQuery()

The query to filter the products.

The supported queries are:

  • List products of all catalogs: empty
  • List products under a catalog: parent=catalogs/{catalog}
  • Get a product by name: name=catalogs/{catalog}/products/{product}

string query = 2;

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

clearResource()

public SearchProductsRequest.Builder clearResource()

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

clone()

public SearchProductsRequest.Builder clone()
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchProductsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

The maximum number of entries that are requested.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getQuery()

public String getQuery()

The query to filter the products.

The supported queries are:

  • List products of all catalogs: empty
  • List products under a catalog: parent=catalogs/{catalog}
  • Get a product by name: name=catalogs/{catalog}/products/{product}

string query = 2;

Returns
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

The query to filter the products.

The supported queries are:

  • List products of all catalogs: empty
  • List products under a catalog: parent=catalogs/{catalog}
  • Get a product by name: name=catalogs/{catalog}/products/{product}

string query = 2;

Returns
TypeDescription
ByteString

The bytes for query.

getResource()

public String getResource()

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for resource.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchProductsRequest other)

public SearchProductsRequest.Builder mergeFrom(SearchProductsRequest other)
Parameter
NameDescription
otherSearchProductsRequest
Returns
TypeDescription
SearchProductsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchProductsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

setPageSize(int value)

public SearchProductsRequest.Builder setPageSize(int value)

The maximum number of entries that are requested.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchProductsRequest.Builder setPageToken(String value)

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchProductsRequest.Builder setPageTokenBytes(ByteString value)

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchProductsRequest.Builder setQuery(String value)

The query to filter the products.

The supported queries are:

  • List products of all catalogs: empty
  • List products under a catalog: parent=catalogs/{catalog}
  • Get a product by name: name=catalogs/{catalog}/products/{product}

string query = 2;

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchProductsRequest.Builder setQueryBytes(ByteString value)

The query to filter the products.

The supported queries are:

  • List products of all catalogs: empty
  • List products under a catalog: parent=catalogs/{catalog}
  • Get a product by name: name=catalogs/{catalog}/products/{product}

string query = 2;

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

setResource(String value)

public SearchProductsRequest.Builder setResource(String value)

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The resource to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setResourceBytes(ByteString value)

public SearchProductsRequest.Builder setResourceBytes(ByteString value)

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for resource to set.

Returns
TypeDescription
SearchProductsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides