Class SearchProductsRequest

public final class SearchProductsRequest extends GeneratedMessageV3 implements SearchProductsRequestOrBuilder

Request message for PrivateCatalog.SearchProducts.

Protobuf type google.cloud.privatecatalog.v1beta1.SearchProductsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchProductsRequest getDefaultInstance()
Returns
TypeDescription
SearchProductsRequest

getDescriptor()

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

newBuilder()

public static SearchProductsRequest.Builder newBuilder()
Returns
TypeDescription
SearchProductsRequest.Builder

newBuilder(SearchProductsRequest prototype)

public static SearchProductsRequest.Builder newBuilder(SearchProductsRequest prototype)
Parameter
NameDescription
prototypeSearchProductsRequest
Returns
TypeDescription
SearchProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchProductsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchProductsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchProductsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchProductsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchProductsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchProductsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchProductsRequest> parser()
Returns
TypeDescription
Parser<SearchProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchProductsRequest

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.

getParserForType()

public Parser<SearchProductsRequest> getParserForType()
Returns
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchProductsRequest.Builder newBuilderForType()
Returns
TypeDescription
SearchProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchProductsRequest.Builder toBuilder()
Returns
TypeDescription
SearchProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException