Package software.amazon.awssdk.services.codecatalyst.model

Class ListWorkflowRunsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codecatalyst.model.CodeCatalystRequest

software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListWorkflowRunsRequest
extends CodeCatalystRequest
implements ToCopyableBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListWorkflowRunsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListWorkflowRunsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSortBy()	For responses, this returns true if the service returned a value for the SortBy property.
Integer	maxResults()	The maximum number of results to show in a single call to this API.
String	nextToken()	A token returned from a call to this API to indicate the next batch of results to return, if any.
String	projectName()	The name of the project in the space.
List<SdkField<?>>	sdkFields()
static Class<? extends ListWorkflowRunsRequest.Builder>	serializableBuilderClass()
List<WorkflowRunSortCriteria>	sortBy()	Information used to sort the items in the returned list.
String	spaceName()	The name of the space.
ListWorkflowRunsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowId()	The ID of the workflow.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

spaceName

public final String spaceName()

The name of the space.

Returns:

The name of the space.

workflowId

public final String workflowId()

The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

Returns:

The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

projectName

public final String projectName()

The name of the project in the space.

Returns:

The name of the project in the space.

nextToken

public final String nextToken()

A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

A token returned from a call to this API to indicate the next batch of results to return, if any.

maxResults

public final Integer maxResults()

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

Returns:

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

hasSortBy

public final boolean hasSortBy()

For responses, this returns true if the service returned a value for the SortBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sortBy

public final List<WorkflowRunSortCriteria> sortBy()

Information used to sort the items in the returned list.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortBy() method.

Returns:

Information used to sort the items in the returned list.

toBuilder

public ListWorkflowRunsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>

Specified by:

toBuilder in class CodeCatalystRequest

builder

public static ListWorkflowRunsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListWorkflowRunsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo