Class Run (0.38.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

Inheritance

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

Implements

RunOrBuilder

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Run getDefaultInstance()
Returns
Type Description
Run

getDescriptor()

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

newBuilder()

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

newBuilder(Run prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getAttributes() (deprecated)

public Map<String,Value> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,Value>

getAttributesCount()

public int getAttributesCount()

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

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

Returns
Type Description
int

getAttributesMap()

public Map<String,Value> getAttributesMap()

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

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

Returns
Type Description
Map<String,Value>

getAttributesOrDefault(String key, Value defaultValue)

public Value getAttributesOrDefault(String key, Value defaultValue)

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

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

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getAttributesOrThrow(String key)

public Value getAttributesOrThrow(String key)

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

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

Parameter
Name Description
key String
Returns
Type Description
Value

getDefaultInstanceForType()

public Run getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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