com.google.cloud.datacatalog.lineage.v1

Interface RunOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Run, Run.Builder

public interface RunOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAttributes(String key) Optional.
Map<String,com.google.protobuf.Value>	getAttributes() Deprecated.
int	getAttributesCount() Optional.
Map<String,com.google.protobuf.Value>	getAttributesMap() Optional.
com.google.protobuf.Value	getAttributesOrDefault(String key, com.google.protobuf.Value defaultValue) Optional.
com.google.protobuf.Value	getAttributesOrThrow(String key) Optional.
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
com.google.protobuf.Timestamp	getEndTime() Optional.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Optional.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Timestamp	getStartTime() Required.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Required.
Run.State	getState() Required.
int	getStateValue() Required.
boolean	hasEndTime() Optional.
boolean	hasStartTime() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

getAttributesCount

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

containsAttributes

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

getAttributes

@Deprecated
Map<String,com.google.protobuf.Value> getAttributes()

Deprecated.

Use getAttributesMap() instead.

getAttributesMap

Map<String,com.google.protobuf.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];

getAttributesOrDefault

com.google.protobuf.Value getAttributesOrDefault(String key,
                                                 com.google.protobuf.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];

getAttributesOrThrow

com.google.protobuf.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];

hasStartTime

boolean hasStartTime()

 Required. The timestamp of the start of the run.
 

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

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Required. The timestamp of the start of the run.
 

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

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Required. The timestamp of the start of the run.
 

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

hasEndTime

boolean hasEndTime()

 Optional. The timestamp of the end of the run.
 

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

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Optional. The timestamp of the end of the run.
 

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

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Optional. The timestamp of the end of the run.
 

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

getStateValue

int getStateValue()

 Required. The state of the run.
 

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

Returns:

The enum numeric value on the wire for state.

getState

Run.State getState()

 Required. The state of the run.
 

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

Returns:

The state.