public final class ListExecutionsRequest extends GeneratedMessageV3 implements ListExecutionsRequestOrBuilder
Request for the
[ListExecutions][]
method.
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VIEW_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListExecutionsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListExecutionsRequest.Builder newBuilder()
newBuilder(ListExecutionsRequest prototype)
public static ListExecutionsRequest.Builder newBuilder(ListExecutionsRequest prototype)
public static ListExecutionsRequest parseDelimitedFrom(InputStream input)
public static ListExecutionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListExecutionsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListExecutionsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(CodedInputStream input)
public static ListExecutionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(InputStream input)
public static ListExecutionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListExecutionsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListExecutionsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListExecutionsRequest getDefaultInstanceForType()
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()
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.
|
getParserForType()
public Parser<ListExecutionsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListExecutionsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListExecutionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListExecutionsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
