Class PurgeProductsResponse.Builder (2.20.0)

public static final class PurgeProductsResponse.Builder extends GeneratedMessageV3.Builder<PurgeProductsResponse.Builder> implements PurgeProductsResponseOrBuilder

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Protobuf type google.cloud.retail.v2alpha.PurgeProductsResponse

Static Methods

getDescriptor()

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

Methods

addAllPurgeSample(Iterable<String> values)

public PurgeProductsResponse.Builder addAllPurgeSample(Iterable<String> values)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valuesIterable<String>

The purgeSample to add.

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

addPurgeSample(String value)

public PurgeProductsResponse.Builder addPurgeSample(String value)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The purgeSample to add.

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

addPurgeSampleBytes(ByteString value)

public PurgeProductsResponse.Builder addPurgeSampleBytes(ByteString value)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes of the purgeSample to add.

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PurgeProductsResponse build()
Returns
TypeDescription
PurgeProductsResponse

buildPartial()

public PurgeProductsResponse buildPartial()
Returns
TypeDescription
PurgeProductsResponse

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPurgeCount()

public PurgeProductsResponse.Builder clearPurgeCount()

The total count of products purged as a result of the operation.

int64 purge_count = 1;

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

clearPurgeSample()

public PurgeProductsResponse.Builder clearPurgeSample()

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public PurgeProductsResponse getDefaultInstanceForType()
Returns
TypeDescription
PurgeProductsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPurgeCount()

public long getPurgeCount()

The total count of products purged as a result of the operation.

int64 purge_count = 1;

Returns
TypeDescription
long

The purgeCount.

getPurgeSample(int index)

public String getPurgeSample(int index)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The purgeSample at the given index.

getPurgeSampleBytes(int index)

public ByteString getPurgeSampleBytes(int index)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the purgeSample at the given index.

getPurgeSampleCount()

public int getPurgeSampleCount()

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
int

The count of purgeSample.

getPurgeSampleList()

public ProtocolStringList getPurgeSampleList()

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the purgeSample.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PurgeProductsResponse other)

public PurgeProductsResponse.Builder mergeFrom(PurgeProductsResponse other)
Parameter
NameDescription
otherPurgeProductsResponse
Returns
TypeDescription
PurgeProductsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPurgeCount(long value)

public PurgeProductsResponse.Builder setPurgeCount(long value)

The total count of products purged as a result of the operation.

int64 purge_count = 1;

Parameter
NameDescription
valuelong

The purgeCount to set.

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

setPurgeSample(int index, String value)

public PurgeProductsResponse.Builder setPurgeSample(int index, String value)

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The purgeSample to set.

Returns
TypeDescription
PurgeProductsResponse.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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