com.google.cloud.retail.v2alpha

Class PurgeProductsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2alpha.PurgeProductsRequest

All Implemented Interfaces:

PurgeProductsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PurgeProductsRequest
extends com.google.protobuf.GeneratedMessageV3
implements PurgeProductsRequestOrBuilder

 Request message for PurgeProducts method.
 

Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurgeProductsRequest.Builder Request message for PurgeProducts method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	FORCE_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PurgeProductsRequest	getDefaultInstance()
PurgeProductsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
boolean	getForce() Actually perform the purge.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<PurgeProductsRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PurgeProductsRequest.Builder	newBuilder()
static PurgeProductsRequest.Builder	newBuilder(PurgeProductsRequest prototype)
PurgeProductsRequest.Builder	newBuilderForType()
protected PurgeProductsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PurgeProductsRequest	parseDelimitedFrom(InputStream input)
static PurgeProductsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeProductsRequest	parseFrom(byte[] data)
static PurgeProductsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeProductsRequest	parseFrom(ByteBuffer data)
static PurgeProductsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeProductsRequest	parseFrom(com.google.protobuf.ByteString data)
static PurgeProductsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeProductsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PurgeProductsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeProductsRequest	parseFrom(InputStream input)
static PurgeProductsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PurgeProductsRequest>	parser()
PurgeProductsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PurgeProductsRequest parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeProductsRequest parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static PurgeProductsRequest parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static PurgeProductsRequest parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static PurgeProductsRequest parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static PurgeProductsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static PurgeProductsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public PurgeProductsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PurgeProductsRequest.Builder newBuilder()

newBuilder

public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)

toBuilder

public PurgeProductsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PurgeProductsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PurgeProductsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<PurgeProductsRequest> parser()

getParserForType

public com.google.protobuf.Parser<PurgeProductsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PurgeProductsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder