Class PurgeExecutionsRequest (3.33.0)

public final class PurgeExecutionsRequest extends GeneratedMessageV3 implements PurgeExecutionsRequestOrBuilder

Request message for MetadataService.PurgeExecutions.

Protobuf type google.cloud.aiplatform.v1.PurgeExecutionsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PurgeExecutionsRequest getDefaultInstance()
Returns
TypeDescription
PurgeExecutionsRequest

getDescriptor()

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

newBuilder()

public static PurgeExecutionsRequest.Builder newBuilder()
Returns
TypeDescription
PurgeExecutionsRequest.Builder

newBuilder(PurgeExecutionsRequest prototype)

public static PurgeExecutionsRequest.Builder newBuilder(PurgeExecutionsRequest prototype)
Parameter
NameDescription
prototypePurgeExecutionsRequest
Returns
TypeDescription
PurgeExecutionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static PurgeExecutionsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PurgeExecutionsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeExecutionsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeExecutionsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PurgeExecutionsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PurgeExecutionsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeExecutionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeExecutionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PurgeExecutionsRequest> parser()
Returns
TypeDescription
Parser<PurgeExecutionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PurgeExecutionsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeExecutionsRequest

getFilter()

public String getFilter()

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

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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

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

Returns
TypeDescription
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 Execution names that would be deleted.

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

Returns
TypeDescription
boolean

The force.

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<PurgeExecutionsRequest> getParserForType()
Returns
TypeDescription
Parser<PurgeExecutionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PurgeExecutionsRequest.Builder newBuilderForType()
Returns
TypeDescription
PurgeExecutionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeExecutionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PurgeExecutionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PurgeExecutionsRequest.Builder toBuilder()
Returns
TypeDescription
PurgeExecutionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException