Package software.amazon.awssdk.services.elasticbeanstalk.model

Class ListPlatformBranchesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPlatformBranchesRequest.Builder,ListPlatformBranchesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListPlatformBranchesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListPlatformBranchesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SearchFilter>	filters()	Criteria for restricting the resulting list of platform branches.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxRecords()	The maximum number of platform branch values returned in one call.
String	nextToken()	For a paginated request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListPlatformBranchesRequest.Builder>	serializableBuilderClass()
ListPlatformBranchesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<SearchFilter> filters()

Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

• Attribute = BranchName:

  • Operator: = | != | begins_with | ends_with | contains | in | not_in

• Attribute = LifecycleState:

  • Operator: = | != | in | not_in

  • Values: beta | supported | deprecated | retired

• Attribute = PlatformName:

  • Operator: = | != | begins_with | ends_with | contains | in | not_in

• Attribute = TierType:

  • Operator: = | !=

  • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

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 hasFilters() method.

Returns:

Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

• Attribute = BranchName:

  • Operator: = | != | begins_with | ends_with | contains | in | not_in

• Attribute = LifecycleState:

  • Operator: = | != | in | not_in

  • Values: beta | supported | deprecated | retired

• Attribute = PlatformName:

  • Operator: = | != | begins_with | ends_with | contains | in | not_in

• Attribute = TierType:

  • Operator: = | !=

  • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

maxRecords

public final Integer maxRecords()

The maximum number of platform branch values returned in one call.

Returns:

The maximum number of platform branch values returned in one call.

nextToken

public final String nextToken()

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Returns:

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

toBuilder

public ListPlatformBranchesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPlatformBranchesRequest.Builder,ListPlatformBranchesRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static ListPlatformBranchesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListPlatformBranchesRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo