Class PurgeProductsRequest (2.14.0)

public final class PurgeProductsRequest extends GeneratedMessageV3 implements PurgeProductsRequestOrBuilder

Request message for PurgeProducts method.

Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PurgeProductsRequest getDefaultInstance()
Returns
TypeDescription
PurgeProductsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(PurgeProductsRequest prototype)

public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)
Parameter
NameDescription
prototypePurgeProductsRequest
Returns
TypeDescription
PurgeProductsRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PurgeProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeProductsRequest

getFilter()

public String getFilter()

Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. "*" implies delete all items in a branch. The eligible fields for filtering are:

  • availability: Double quoted Product.availability string.
  • create_time : in ISO 8601 "zulu" format. Supported syntax:
  • Comparators (">", "<", ">=", "<=", "="). Examples:
    • create_time <= "2015-02-13T17:05:46Z"
    • availability = "IN_STOCK"
  • Conjunctions ("AND") Examples:
    • create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"
  • Disjunctions ("OR") Examples:
    • create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"
  • Can support nested queries. Examples:
    • (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")
  • Filter Limits:
    • Filter should not contain more than 6 conditions.
    • Max nesting depth should not exceed 2 levels. Examples queries:
  • Delete back order products created before a timestamp. create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. "*" implies delete all items in a branch. The eligible fields for filtering are:

  • availability: Double quoted Product.availability string.
  • create_time : in ISO 8601 "zulu" format. Supported syntax:
  • Comparators (">", "<", ">=", "<=", "="). Examples:
    • create_time <= "2015-02-13T17:05:46Z"
    • availability = "IN_STOCK"
  • Conjunctions ("AND") Examples:
    • create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"
  • Disjunctions ("OR") Examples:
    • create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"
  • Can support nested queries. Examples:
    • (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")
  • Filter Limits:
    • Filter should not contain more than 6 conditions.
    • Max nesting depth should not exceed 2 levels. Examples queries:
  • Delete back order products created before a timestamp. create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for filter.

getForce()

public boolean getForce()

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

bool force = 3;

Returns
TypeDescription
boolean

The force.

getParent()

public String getParent()

Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<PurgeProductsRequest> getParserForType()
Returns
TypeDescription
Parser<PurgeProductsRequest>
Overrides

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 PurgeProductsRequest.Builder newBuilderForType()
Returns
TypeDescription
PurgeProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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