Package com.google.cloud.retail.v2alpha

Class PurgeProductsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>

com.google.cloud.retail.v2alpha.PurgeProductsRequest.Builder

All Implemented Interfaces:

PurgeProductsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PurgeProductsRequest

public static final class PurgeProductsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>
implements PurgeProductsRequestOrBuilder

 Request message for PurgeProducts method.
 

Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest

Method Summary

Modifier and Type	Method	Description
PurgeProductsRequest	build()
PurgeProductsRequest	buildPartial()
PurgeProductsRequest.Builder	clear()
PurgeProductsRequest.Builder	clearFilter()	Required.
PurgeProductsRequest.Builder	clearForce()	Actually perform the purge.
PurgeProductsRequest.Builder	clearParent()	Required.
PurgeProductsRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter()	Required.
com.google.protobuf.ByteString	getFilterBytes()	Required.
boolean	getForce()	Actually perform the purge.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
PurgeProductsRequest.Builder	mergeFrom(PurgeProductsRequest other)
PurgeProductsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PurgeProductsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
PurgeProductsRequest.Builder	setFilter(String value)	Required.
PurgeProductsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value)	Required.
PurgeProductsRequest.Builder	setForce(boolean value)	Actually perform the purge.
PurgeProductsRequest.Builder	setParent(String value)	Required.
PurgeProductsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value)	Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>

clear

public PurgeProductsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>

getDefaultInstanceForType

public PurgeProductsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PurgeProductsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PurgeProductsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public PurgeProductsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeProductsRequest.Builder>

mergeFrom

public PurgeProductsRequest.Builder mergeFrom(PurgeProductsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PurgeProductsRequest.Builder>

mergeFrom

public PurgeProductsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeProductsRequest.Builder>

Throws:

IOException

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

Specified by:

getParent in interface PurgeProductsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface PurgeProductsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:

value - The parent to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setParentBytes

public PurgeProductsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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][google.cloud.retail.v2alpha.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];

Specified by:

getFilter in interface PurgeProductsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.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];

Specified by:

getFilterBytes in interface PurgeProductsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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][google.cloud.retail.v2alpha.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];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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][google.cloud.retail.v2alpha.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:

This builder for chaining.

setFilterBytes

public PurgeProductsRequest.Builder setFilterBytes(com.google.protobuf.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][google.cloud.retail.v2alpha.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];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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;

Specified by:

getForce in interface PurgeProductsRequestOrBuilder

Returns:

The force.

setForce

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;

Parameters:

value - The force to set.

Returns:

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:

This builder for chaining.