Class PurgeProductsRequest (3.47.0) 

public final class PurgeProductsRequest extends GeneratedMessageV3 implements PurgeProductsRequestOrBuilder

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1.PurgeProductsRequest

Inheritance

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

Static Fields

DELETE_ORPHAN_PRODUCTS_FIELD_NUMBER

public static final int DELETE_ORPHAN_PRODUCTS_FIELD_NUMBER
Field Value
Type Description
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_SET_PURGE_CONFIG_FIELD_NUMBER

public static final int PRODUCT_SET_PURGE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurgeProductsRequest getDefaultInstance()
Returns
Type Description
PurgeProductsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PurgeProductsRequest.Builder newBuilder()
Returns
Type Description
PurgeProductsRequest.Builder

newBuilder(PurgeProductsRequest prototype)

public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)
Parameter
Name Description
prototype PurgeProductsRequest
Returns
Type Description
PurgeProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static PurgeProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PurgeProductsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeProductsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeProductsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PurgeProductsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PurgeProductsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PurgeProductsRequest> parser()
Returns
Type Description
Parser<PurgeProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PurgeProductsRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
boolean

The deleteOrphanProducts.

getForce()

public boolean getForce()

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

bool force = 4;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<PurgeProductsRequest> getParserForType()
Returns
Type Description
Parser<PurgeProductsRequest>
Overrides

getProductSetPurgeConfig()

public ProductSetPurgeConfig getProductSetPurgeConfig()

Specify which ProductSet contains the Products to be deleted.

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

Returns
Type Description
ProductSetPurgeConfig

The productSetPurgeConfig.

getProductSetPurgeConfigOrBuilder()

public ProductSetPurgeConfigOrBuilder getProductSetPurgeConfigOrBuilder()

Specify which ProductSet contains the Products to be deleted.

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

Returns
Type Description
ProductSetPurgeConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetCase()

public PurgeProductsRequest.TargetCase getTargetCase()
Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the productSetPurgeConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PurgeProductsRequest.Builder newBuilderForType()
Returns
Type Description
PurgeProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PurgeProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PurgeProductsRequest.Builder toBuilder()
Returns
Type Description
PurgeProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException