Class PurgeProductsRequest.Builder (2.31.0) 

public static final class PurgeProductsRequest.Builder extends GeneratedMessageV3.Builder<PurgeProductsRequest.Builder> implements PurgeProductsRequestOrBuilder

Request message for PurgeProducts method.

Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeProductsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PurgeProductsRequest build()
Returns
TypeDescription
PurgeProductsRequest

buildPartial()

public PurgeProductsRequest buildPartial()
Returns
TypeDescription
PurgeProductsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public PurgeProductsRequest.Builder clearFilter()

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
PurgeProductsRequest.Builder

This builder for chaining.

clearForce()

public PurgeProductsRequest.Builder clearForce()

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
PurgeProductsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public PurgeProductsRequest.Builder clearParent()

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
PurgeProductsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public PurgeProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeProductsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PurgeProductsRequest other)

public PurgeProductsRequest.Builder mergeFrom(PurgeProductsRequest other)
Parameter
NameDescription
otherPurgeProductsRequest
Returns
TypeDescription
PurgeProductsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public PurgeProductsRequest.Builder setFilter(String value)

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];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public PurgeProductsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

setForce(boolean value)

public PurgeProductsRequest.Builder setForce(boolean value)

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;

Parameter
NameDescription
valueboolean

The force to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

setParent(String value)

public PurgeProductsRequest.Builder setParent(String value)

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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public PurgeProductsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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