Class PurgeProductsRequest.Builder (3.18.0)

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

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1.PurgeProductsRequest

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

clearDeleteOrphanProducts()

public PurgeProductsRequest.Builder clearDeleteOrphanProducts()

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

bool delete_orphan_products = 3;

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearForce()

public PurgeProductsRequest.Builder clearForce()

The default value is false. Override this value to true to actually perform the purge.

bool force = 4;

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 project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

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

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

clearProductSetPurgeConfig()

public PurgeProductsRequest.Builder clearProductSetPurgeConfig()

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Returns
TypeDescription
PurgeProductsRequest.Builder

clearTarget()

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

clone()

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

getDefaultInstanceForType()

public PurgeProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeProductsRequest

getDeleteOrphanProducts()

public boolean getDeleteOrphanProducts()

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

bool delete_orphan_products = 3;

Returns
TypeDescription
boolean

The deleteOrphanProducts.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getForce()

public boolean getForce()

The default value is false. Override this value to true to actually perform the purge.

bool force = 4;

Returns
TypeDescription
boolean

The force.

getParent()

public String getParent()

Required. The project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

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

Returns
TypeDescription
ByteString

The bytes for parent.

getProductSetPurgeConfig()

public ProductSetPurgeConfig getProductSetPurgeConfig()

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Returns
TypeDescription
ProductSetPurgeConfig

The productSetPurgeConfig.

getProductSetPurgeConfigBuilder()

public ProductSetPurgeConfig.Builder getProductSetPurgeConfigBuilder()

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Returns
TypeDescription
ProductSetPurgeConfig.Builder

getProductSetPurgeConfigOrBuilder()

public ProductSetPurgeConfigOrBuilder getProductSetPurgeConfigOrBuilder()

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Returns
TypeDescription
ProductSetPurgeConfigOrBuilder

getTargetCase()

public PurgeProductsRequest.TargetCase getTargetCase()
Returns
TypeDescription
PurgeProductsRequest.TargetCase

hasDeleteOrphanProducts()

public boolean hasDeleteOrphanProducts()

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

bool delete_orphan_products = 3;

Returns
TypeDescription
boolean

Whether the deleteOrphanProducts field is set.

hasProductSetPurgeConfig()

public boolean hasProductSetPurgeConfig()

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Returns
TypeDescription
boolean

Whether the productSetPurgeConfig field is set.

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

mergeProductSetPurgeConfig(ProductSetPurgeConfig value)

public PurgeProductsRequest.Builder mergeProductSetPurgeConfig(ProductSetPurgeConfig value)

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Parameter
NameDescription
valueProductSetPurgeConfig
Returns
TypeDescription
PurgeProductsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDeleteOrphanProducts(boolean value)

public PurgeProductsRequest.Builder setDeleteOrphanProducts(boolean value)

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

bool delete_orphan_products = 3;

Parameter
NameDescription
valueboolean

The deleteOrphanProducts to set.

Returns
TypeDescription
PurgeProductsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setForce(boolean value)

public PurgeProductsRequest.Builder setForce(boolean value)

The default value is false. Override this value to true to actually perform the purge.

bool force = 4;

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 project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

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 project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

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.

setProductSetPurgeConfig(ProductSetPurgeConfig value)

public PurgeProductsRequest.Builder setProductSetPurgeConfig(ProductSetPurgeConfig value)

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Parameter
NameDescription
valueProductSetPurgeConfig
Returns
TypeDescription
PurgeProductsRequest.Builder

setProductSetPurgeConfig(ProductSetPurgeConfig.Builder builderForValue)

public PurgeProductsRequest.Builder setProductSetPurgeConfig(ProductSetPurgeConfig.Builder builderForValue)

Specify which ProductSet contains the Products to be deleted.

.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;

Parameter
NameDescription
builderForValueProductSetPurgeConfig.Builder
Returns
TypeDescription
PurgeProductsRequest.Builder

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