Class ListExecutionsRequest.Builder (2.49.0)

public static final class ListExecutionsRequest.Builder extends GeneratedMessageV3.Builder<ListExecutionsRequest.Builder> implements ListExecutionsRequestOrBuilder

Request for the [ListExecutions][] method.

Protobuf type google.cloud.workflows.executions.v1.ListExecutionsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListExecutionsRequest build()
Returns
Type Description
ListExecutionsRequest

buildPartial()

public ListExecutionsRequest buildPartial()
Returns
Type Description
ListExecutionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ListExecutionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListExecutionsRequest.Builder
Overrides

clearFilter()

public ListExecutionsRequest.Builder clearFilter()

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListExecutionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListExecutionsRequest.Builder
Overrides

clearOrderBy()

public ListExecutionsRequest.Builder clearOrderBy()

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clearPageSize()

public ListExecutionsRequest.Builder clearPageSize()

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

int32 page_size = 2;

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListExecutionsRequest.Builder clearPageToken()

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clearParent()

public ListExecutionsRequest.Builder clearParent()

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clearView()

public ListExecutionsRequest.Builder clearView()

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListExecutionsRequest getDefaultInstanceForType()
Returns
Type Description
ListExecutionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getView()

public ExecutionView getView()

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExecutionView

The view.

getViewValue()

public int getViewValue()

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListExecutionsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public ListExecutionsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListExecutionsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListExecutionsRequest.Builder setFilter(String value)

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListExecutionsRequest.Builder setFilterBytes(ByteString value)

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListExecutionsRequest.Builder setOrderBy(String value)

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListExecutionsRequest.Builder setOrderByBytes(ByteString value)

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListExecutionsRequest.Builder setPageSize(int value)

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListExecutionsRequest.Builder setPageToken(String value)

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListExecutionsRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListExecutionsRequest.Builder setParent(String value)

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListExecutionsRequest.Builder setParentBytes(ByteString value)

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

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

public ListExecutionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListExecutionsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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

setView(ExecutionView value)

public ListExecutionsRequest.Builder setView(ExecutionView value)

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ExecutionView

The view to set.

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListExecutionsRequest.Builder setViewValue(int value)

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
ListExecutionsRequest.Builder

This builder for chaining.