Class PurgeArtifactsRequest (3.46.0)

public final class PurgeArtifactsRequest extends GeneratedMessageV3 implements PurgeArtifactsRequestOrBuilder

Request message for MetadataService.PurgeArtifacts.

Protobuf type google.cloud.aiplatform.v1.PurgeArtifactsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_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

Static Methods

getDefaultInstance()

public static PurgeArtifactsRequest getDefaultInstance()
Returns
Type Description
PurgeArtifactsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(PurgeArtifactsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PurgeArtifactsRequest getDefaultInstanceForType()
Returns
Type Description
PurgeArtifactsRequest

getFilter()

public String getFilter()

Required. A required filter matching the Artifacts to be purged. E.g., update_time <= 2020-11-19T11:30:00-04:00.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. A required filter matching the Artifacts to be purged. E.g., update_time <= 2020-11-19T11:30:00-04:00.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getForce()

public boolean getForce()

Optional. Flag to indicate to actually perform the purge. If force is set to false, the method will return a sample of Artifact names that would be deleted.

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getParent()

public String getParent()

Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 PurgeArtifactsRequest.Builder newBuilderForType()
Returns
Type Description
PurgeArtifactsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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