Class Run.Builder (0.35.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Run.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Run.Builder
Overrides

build()

public Run build()
Returns
Type Description
Run

buildPartial()

public Run buildPartial()
Returns
Type Description
Run

clear()

public Run.Builder clear()
Returns
Type Description
Run.Builder
Overrides

clearAttributes()

public Run.Builder clearAttributes()
Returns
Type Description
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
Type Description
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
Type Description
Run.Builder

clearField(Descriptors.FieldDescriptor field)

public Run.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
Run.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Run.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
Run.Builder

This builder for chaining.

clone()

public Run.Builder clone()
Returns
Type Description
Run.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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.

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
Type Description
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
Type Description
TimestampOrBuilder

getMutableAttributes() (deprecated)

public Map<String,Value> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
Type Description
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
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.

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.

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
Type Description
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
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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
Run.Builder

mergeFrom(Run other)

public Run.Builder mergeFrom(Run other)
Parameter
Name Description
other Run
Returns
Type Description
Run.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Run.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Run.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Run.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
Run.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Run.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Run.Builder
Overrides

putAllAttributes(Map<String,Value> values)

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

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
values Map<String,Value>
Returns
Type Description
Run.Builder

putAttributes(String key, Value value)

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

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
value Value
Returns
Type Description
Run.Builder

putAttributesBuilderIfAbsent(String key)

public Value.Builder putAttributesBuilderIfAbsent(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
Builder

removeAttributes(String key)

public Run.Builder removeAttributes(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
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
Name Description
value String

The displayName to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
Run.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Run.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The name to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value Run.State

The state to set.

Returns
Type Description
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
Name Description
value int

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

Returns
Type Description
Run.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Run.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Run.Builder
Overrides