Class Run.Builder (0.19.0)

public static final class Run.Builder extends GeneratedMessageV3.Builder<Run.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Run.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Run.Builder
Overrides

build()

public Run build()
Returns
TypeDescription
Run

buildPartial()

public Run buildPartial()
Returns
TypeDescription
Run

clear()

public Run.Builder clear()
Returns
TypeDescription
Run.Builder
Overrides

clearAttributes()

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

clearDisplayName()

public Run.Builder clearDisplayName()

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
Run.Builder

This builder for chaining.

clearEndTime()

public Run.Builder clearEndTime()

Optional. The timestamp of the end of the run.

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

Returns
TypeDescription
Run.Builder

clearField(Descriptors.FieldDescriptor field)

public Run.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Run.Builder
Overrides

clearName()

public Run.Builder clearName()

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
Run.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Run.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Run.Builder
Overrides

clearStartTime()

public Run.Builder clearStartTime()

Required. The timestamp of the start of the run.

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

Returns
TypeDescription
Run.Builder

clearState()

public Run.Builder clearState()

Required. The state of the run.

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

Returns
TypeDescription
Run.Builder

This builder for chaining.

clone()

public Run.Builder clone()
Returns
TypeDescription
Run.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Optional. The timestamp of the end of the run.

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

Returns
TypeDescription
Builder

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

getMutableAttributes()

public Map<String,Value> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Required. The timestamp of the start of the run.

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

Returns
TypeDescription
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTime(Timestamp value)

public Run.Builder mergeEndTime(Timestamp value)

Optional. The timestamp of the end of the run.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Run.Builder

mergeFrom(Run other)

public Run.Builder mergeFrom(Run other)
Parameter
NameDescription
otherRun
Returns
TypeDescription
Run.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Run.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Run.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Run.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Run.Builder
Overrides

mergeStartTime(Timestamp value)

public Run.Builder mergeStartTime(Timestamp value)

Required. The timestamp of the start of the run.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Run.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Run.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Run.Builder
Overrides

putAllAttributes(Map<String,Value> values)

public Run.Builder putAllAttributes(Map<String,Value> values)

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
valuesMap<String,Value>
Returns
TypeDescription
Run.Builder

putAttributes(String key, Value value)

public Run.Builder putAttributes(String key, Value value)

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
valueValue
Returns
TypeDescription
Run.Builder

removeAttributes(String key)

public Run.Builder removeAttributes(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
Run.Builder

setDisplayName(String value)

public Run.Builder setDisplayName(String value)

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];

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Run.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Run.Builder setEndTime(Timestamp value)

Optional. The timestamp of the end of the run.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Run.Builder

setEndTime(Timestamp.Builder builderForValue)

public Run.Builder setEndTime(Timestamp.Builder builderForValue)

Optional. The timestamp of the end of the run.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Run.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Run.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Run.Builder
Overrides

setName(String value)

public Run.Builder setName(String value)

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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Run.Builder setNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Run.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Run.Builder
Overrides

setStartTime(Timestamp value)

public Run.Builder setStartTime(Timestamp value)

Required. The timestamp of the start of the run.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Run.Builder

setStartTime(Timestamp.Builder builderForValue)

public Run.Builder setStartTime(Timestamp.Builder builderForValue)

Required. The timestamp of the start of the run.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Run.Builder

setState(Run.State value)

public Run.Builder setState(Run.State value)

Required. The state of the run.

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

Parameter
NameDescription
valueRun.State

The state to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setStateValue(int value)

public Run.Builder setStateValue(int value)

Required. The state of the run.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Run.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Run.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Run.Builder
Overrides