Class Run (0.21.0)

public final class Run extends GeneratedMessageV3 implements RunOrBuilder

A lineage run represents an execution of a process that creates lineage events.

Protobuf type google.cloud.datacatalog.lineage.v1.Run

Implements

RunOrBuilder

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Run getDefaultInstance()
Returns
TypeDescription
Run

getDescriptor()

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

newBuilder()

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

newBuilder(Run prototype)

public static Run.Builder newBuilder(Run prototype)
Parameter
NameDescription
prototypeRun
Returns
TypeDescription
Run.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Optional. The attributes of the run. Can be anything, for example, a string with an SQL request. Up to 100 attributes are allowed.

map<string, .google.protobuf.Value> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAttributes()

public Map<String,Value> getAttributes()

Use #getAttributesMap() instead.

Returns
TypeDescription
Map<String,Value>

getAttributesCount()

public int getAttributesCount()

Optional. The attributes of the run. Can be anything, for example, a string with an SQL request. Up to 100 attributes are allowed.

map<string, .google.protobuf.Value> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getAttributesMap()

public Map<String,Value> getAttributesMap()

Optional. The attributes of the run. Can be anything, for example, a string with an SQL request. Up to 100 attributes are allowed.

map<string, .google.protobuf.Value> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,Value>

getAttributesOrDefault(String key, Value defaultValue)

public Value getAttributesOrDefault(String key, Value defaultValue)

Optional. The attributes of the run. Can be anything, for example, a string with an SQL request. Up to 100 attributes are allowed.

map<string, .google.protobuf.Value> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getAttributesOrThrow(String key)

public Value getAttributesOrThrow(String key)

Optional. The attributes of the run. Can be anything, for example, a string with an SQL request. Up to 100 attributes are allowed.

map<string, .google.protobuf.Value> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getDefaultInstanceForType()

public Run getDefaultInstanceForType()
Returns
TypeDescription
Run

getDisplayName()

public String getDisplayName()

Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for displayName.

getEndTime()

public Timestamp getEndTime()

Optional. The timestamp of the end of the run.

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. The timestamp of the end of the run.

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TimestampOrBuilder

getName()

public String getName()

Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Required. The timestamp of the start of the run.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Required. The timestamp of the start of the run.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimestampOrBuilder

getState()

public Run.State getState()

Required. The state of the run.

.google.cloud.datacatalog.lineage.v1.Run.State state = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Run.State

The state.

getStateValue()

public int getStateValue()

Required. The state of the run.

.google.cloud.datacatalog.lineage.v1.Run.State state = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasEndTime()

public boolean hasEndTime()

Optional. The timestamp of the end of the run.

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Required. The timestamp of the start of the run.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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