Class ScheduledEvaluationRun (0.3.0)

public final class ScheduledEvaluationRun extends GeneratedMessage implements ScheduledEvaluationRunOrBuilder

Represents a scheduled evaluation run configuration.

Protobuf type google.cloud.ces.v1beta.ScheduledEvaluationRun

Static Fields

ACTIVE_FIELD_NUMBER

public static final int ACTIVE_FIELD_NUMBER
Field Value
Type Description
int

CREATED_BY_FIELD_NUMBER

public static final int CREATED_BY_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LAST_COMPLETED_RUN_FIELD_NUMBER

public static final int LAST_COMPLETED_RUN_FIELD_NUMBER
Field Value
Type Description
int

LAST_UPDATED_BY_FIELD_NUMBER

public static final int LAST_UPDATED_BY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NEXT_SCHEDULED_EXECUTION_TIME_FIELD_NUMBER

public static final int NEXT_SCHEDULED_EXECUTION_TIME_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_FIELD_NUMBER

public static final int REQUEST_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULING_CONFIG_FIELD_NUMBER

public static final int SCHEDULING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_EXECUTIONS_FIELD_NUMBER

public static final int TOTAL_EXECUTIONS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ScheduledEvaluationRun getDefaultInstance()
Returns
Type Description
ScheduledEvaluationRun

getDescriptor()

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

newBuilder()

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

newBuilder(ScheduledEvaluationRun prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActive()

public boolean getActive()

Optional. Whether this config is active

bool active = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The active.

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the scheduled evaluation run was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the scheduled evaluation run was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreatedBy()

public String getCreatedBy()

Output only. The user who created the scheduled evaluation run.

string created_by = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The createdBy.

getCreatedByBytes()

public ByteString getCreatedByBytes()

Output only. The user who created the scheduled evaluation run.

string created_by = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for createdBy.

getDefaultInstanceForType()

public ScheduledEvaluationRun getDefaultInstanceForType()
Returns
Type Description
ScheduledEvaluationRun

getDescription()

public String getDescription()

Optional. User-defined description of the scheduled evaluation run.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-defined description of the scheduled evaluation run.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. User-defined display name of the scheduled evaluation run config.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User-defined display name of the scheduled evaluation run config.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getLastCompletedRun()

public String getLastCompletedRun()

Output only. The last successful EvaluationRun of this scheduled execution. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string last_completed_run = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The lastCompletedRun.

getLastCompletedRunBytes()

public ByteString getLastCompletedRunBytes()

Output only. The last successful EvaluationRun of this scheduled execution. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string last_completed_run = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for lastCompletedRun.

getLastUpdatedBy()

public String getLastUpdatedBy()

Output only. The user who last updated the evaluation.

string last_updated_by = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastUpdatedBy.

getLastUpdatedByBytes()

public ByteString getLastUpdatedByBytes()

Output only. The user who last updated the evaluation.

string last_updated_by = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastUpdatedBy.

getName()

public String getName()

Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}

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

Returns
Type Description
ByteString

The bytes for name.

getNextScheduledExecutionTime()

public Timestamp getNextScheduledExecutionTime()

Output only. The next time this is scheduled to execute

.google.protobuf.Timestamp next_scheduled_execution_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The nextScheduledExecutionTime.

getNextScheduledExecutionTimeOrBuilder()

public TimestampOrBuilder getNextScheduledExecutionTimeOrBuilder()

Output only. The next time this is scheduled to execute

.google.protobuf.Timestamp next_scheduled_execution_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getRequest()

public RunEvaluationRequest getRequest()

Required. The RunEvaluationRequest to schedule

.google.cloud.ces.v1beta.RunEvaluationRequest request = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RunEvaluationRequest

The request.

getRequestOrBuilder()

public RunEvaluationRequestOrBuilder getRequestOrBuilder()

Required. The RunEvaluationRequest to schedule

.google.cloud.ces.v1beta.RunEvaluationRequest request = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RunEvaluationRequestOrBuilder

getSchedulingConfig()

public ScheduledEvaluationRun.SchedulingConfig getSchedulingConfig()

Required. Configuration for the timing and frequency with which to execute the evaluations.

.google.cloud.ces.v1beta.ScheduledEvaluationRun.SchedulingConfig scheduling_config = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ScheduledEvaluationRun.SchedulingConfig

The schedulingConfig.

getSchedulingConfigOrBuilder()

public ScheduledEvaluationRun.SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()

Required. Configuration for the timing and frequency with which to execute the evaluations.

.google.cloud.ces.v1beta.ScheduledEvaluationRun.SchedulingConfig scheduling_config = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ScheduledEvaluationRun.SchedulingConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalExecutions()

public int getTotalExecutions()

Output only. The total number of times this run has been executed

int32 total_executions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The totalExecutions.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the scheduled evaluation run was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasNextScheduledExecutionTime()

public boolean hasNextScheduledExecutionTime()

Output only. The next time this is scheduled to execute

.google.protobuf.Timestamp next_scheduled_execution_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the nextScheduledExecutionTime field is set.

hasRequest()

public boolean hasRequest()

Required. The RunEvaluationRequest to schedule

.google.cloud.ces.v1beta.RunEvaluationRequest request = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the request field is set.

hasSchedulingConfig()

public boolean hasSchedulingConfig()

Required. Configuration for the timing and frequency with which to execute the evaluations.

.google.cloud.ces.v1beta.ScheduledEvaluationRun.SchedulingConfig scheduling_config = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the schedulingConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the evaluation was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ScheduledEvaluationRun.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ScheduledEvaluationRun.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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