ListExecutionsRequest.Builder (proto-google-cloud-workflow-executions-v1 2.33.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>
    - - com.google.cloud.workflows.executions.v1.ListExecutionsRequest.Builder

All Implemented Interfaces:

ListExecutionsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListExecutionsRequest
```
public static final class ListExecutionsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>
implements ListExecutionsRequestOrBuilder
```
```
 Request for the
 [ListExecutions][]
 method.
 
```
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListExecutionsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListExecutionsRequest`	`build()`
`ListExecutionsRequest`	`buildPartial()`
`ListExecutionsRequest.Builder`	`clear()`
`ListExecutionsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListExecutionsRequest.Builder`	`clearFilter()` Optional.
`ListExecutionsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListExecutionsRequest.Builder`	`clearOrderBy()` Optional.
`ListExecutionsRequest.Builder`	`clearPageSize()` Maximum number of executions to return per call.
`ListExecutionsRequest.Builder`	`clearPageToken()` A page token, received from a previous `ListExecutions` call.
`ListExecutionsRequest.Builder`	`clearParent()` Required.
`ListExecutionsRequest.Builder`	`clearView()` Optional.
`ListExecutionsRequest.Builder`	`clone()`
`ListExecutionsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFilter()` Optional.
`com.google.protobuf.ByteString`	`getFilterBytes()` Optional.
`String`	`getOrderBy()` Optional.
`com.google.protobuf.ByteString`	`getOrderByBytes()` Optional.
`int`	`getPageSize()` Maximum number of executions to return per call.
`String`	`getPageToken()` A page token, received from a previous `ListExecutions` call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token, received from a previous `ListExecutions` call.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`ExecutionView`	`getView()` Optional.
`int`	`getViewValue()` Optional.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListExecutionsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListExecutionsRequest.Builder`	`mergeFrom(ListExecutionsRequest other)`
`ListExecutionsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListExecutionsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListExecutionsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListExecutionsRequest.Builder`	`setFilter(String value)` Optional.
`ListExecutionsRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` Optional.
`ListExecutionsRequest.Builder`	`setOrderBy(String value)` Optional.
`ListExecutionsRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` Optional.
`ListExecutionsRequest.Builder`	`setPageSize(int value)` Maximum number of executions to return per call.
`ListExecutionsRequest.Builder`	`setPageToken(String value)` A page token, received from a previous `ListExecutions` call.
`ListExecutionsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A page token, received from a previous `ListExecutions` call.
`ListExecutionsRequest.Builder`	`setParent(String value)` Required.
`ListExecutionsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListExecutionsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListExecutionsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListExecutionsRequest.Builder`	`setView(ExecutionView value)` Optional.
`ListExecutionsRequest.Builder`	`setViewValue(int value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

clear
```
public ListExecutionsRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

getDefaultInstanceForType
```
public ListExecutionsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListExecutionsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListExecutionsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ListExecutionsRequest.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

setField

public ListExecutionsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

clearField
```
public ListExecutionsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

clearOneof
```
public ListExecutionsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

setRepeatedField

public ListExecutionsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

addRepeatedField

public ListExecutionsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

mergeFrom
```
public ListExecutionsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListExecutionsRequest.Builder>

mergeFrom

public ListExecutionsRequest.Builder mergeFrom(ListExecutionsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListExecutionsRequest.Builder>

mergeFrom
```
public ListExecutionsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListExecutionsRequest.Builder>

Throws:

IOException

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) = { ... }
Specified by:

getParent in interface ListExecutionsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getParentBytes in interface ListExecutionsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:: value - The parent to set.
Returns:: 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:: This builder for chaining.

setParentBytes

public ListExecutionsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

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;

Specified by:: getPageSize in interface ListExecutionsRequestOrBuilder
Returns:: The pageSize.

setPageSize

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;

Parameters:: value - The pageSize to set.
Returns:: 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:: This builder for chaining.

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;

Specified by:: getPageToken in interface ListExecutionsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

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

Specified by:: getPageTokenBytes in interface ListExecutionsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

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;

Parameters:: value - The pageToken to set.
Returns:: 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:: This builder for chaining.

setPageTokenBytes

public ListExecutionsRequest.Builder setPageTokenBytes(com.google.protobuf.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;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

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];
Specified by:

getViewValue in interface ListExecutionsRequestOrBuilder

Returns:

The enum numeric value on the wire for view.

setViewValue
```
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];
Parameters:

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

Returns:

This builder for chaining.

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];
Specified by:

getView in interface ListExecutionsRequestOrBuilder

Returns:

The view.

setView

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

Parameters:: value - The view to set.
Returns:: 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:: This builder for chaining.

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

Specified by:: getFilter in interface ListExecutionsRequestOrBuilder
Returns:: The filter.

getFilterBytes

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

Specified by:: getFilterBytes in interface ListExecutionsRequestOrBuilder
Returns:: The bytes for filter.

setFilter

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

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

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:: This builder for chaining.

setFilterBytes

public ListExecutionsRequest.Builder setFilterBytes(com.google.protobuf.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];

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.