Class SearchProductsRequest (0.48.0) 

public final class SearchProductsRequest extends GeneratedMessageV3 implements SearchProductsRequestOrBuilder

Request message for PrivateCatalog.SearchProducts.

Protobuf type google.cloud.privatecatalog.v1beta1.SearchProductsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchProductsRequest

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

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchProductsRequest getDefaultInstance()
Returns
Type Description
SearchProductsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchProductsRequest.Builder newBuilder()
Returns
Type Description
SearchProductsRequest.Builder

newBuilder(SearchProductsRequest prototype)

public static SearchProductsRequest.Builder newBuilder(SearchProductsRequest prototype)
Parameter
Name Description
prototype SearchProductsRequest
Returns
Type Description
SearchProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchProductsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchProductsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchProductsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchProductsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchProductsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchProductsRequest> parser()
Returns
Type Description
Parser<SearchProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchProductsRequest getDefaultInstanceForType()
Returns
Type Description
SearchProductsRequest

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.

getParserForType()

public Parser<SearchProductsRequest> getParserForType()
Returns
Type Description
Parser<SearchProductsRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchProductsRequest.Builder newBuilderForType()
Returns
Type Description
SearchProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchProductsRequest.Builder toBuilder()
Returns
Type Description
SearchProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException