Class SearchProductsRequest.Builder (0.50.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchProductsRequest.Builder
Overrides

build()

public SearchProductsRequest build()
Returns
Type Description
SearchProductsRequest

buildPartial()

public SearchProductsRequest buildPartial()
Returns
Type Description
SearchProductsRequest

clear()

public SearchProductsRequest.Builder clear()
Returns
Type Description
SearchProductsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchProductsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchProductsRequest.Builder
Overrides

clearPageSize()

public SearchProductsRequest.Builder clearPageSize()

The maximum number of entries that are requested.

int32 page_size = 3;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
SearchProductsRequest.Builder

This builder for chaining.

clone()

public SearchProductsRequest.Builder clone()
Returns
Type Description
SearchProductsRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchProductsRequest getDefaultInstanceForType()
Returns
Type Description
SearchProductsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

The maximum number of entries that are requested.

int32 page_size = 3;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for resource.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchProductsRequest other)

public SearchProductsRequest.Builder mergeFrom(SearchProductsRequest other)
Parameter
Name Description
other SearchProductsRequest
Returns
Type Description
SearchProductsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchProductsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchProductsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchProductsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value int

The pageSize to set.

Returns
Type Description
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
Name Description
value String

The pageToken to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
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
Name Description
value String

The query to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for query to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value String

The resource to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for resource to set.

Returns
Type Description
SearchProductsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchProductsRequest.Builder
Overrides