Class ListPipesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListPipesRequest.Builder,
ListPipesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListPipesRequest.Builder
builder()
final PipeState
The state the pipe is in.final String
The state the pipe is in.final RequestedPipeState
The state the pipe should be in.final String
The state the pipe should be in.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
limit()
The maximum number of pipes to include in the response.final String
A value that will return a subset of the pipes associated with this account.final String
IfnextToken
is returned, there are more results available.static Class
<? extends ListPipesRequest.Builder> final String
The prefix matching the pipe source.final String
The prefix matching the pipe target.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
currentState
The state the pipe is in.
If the service returns an enum value that is not available in the current SDK version,
currentState
will returnPipeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrentStateAsString()
.- Returns:
- The state the pipe is in.
- See Also:
-
currentStateAsString
The state the pipe is in.
If the service returns an enum value that is not available in the current SDK version,
currentState
will returnPipeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrentStateAsString()
.- Returns:
- The state the pipe is in.
- See Also:
-
desiredState
The state the pipe should be in.
If the service returns an enum value that is not available in the current SDK version,
desiredState
will returnRequestedPipeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdesiredStateAsString()
.- Returns:
- The state the pipe should be in.
- See Also:
-
desiredStateAsString
The state the pipe should be in.
If the service returns an enum value that is not available in the current SDK version,
desiredState
will returnRequestedPipeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdesiredStateAsString()
.- Returns:
- The state the pipe should be in.
- See Also:
-
limit
The maximum number of pipes to include in the response.
- Returns:
- The maximum number of pipes to include in the response.
-
namePrefix
A value that will return a subset of the pipes associated with this account. For example,
"NamePrefix": "ABC"
will return all endpoints with "ABC" in the name.- Returns:
- A value that will return a subset of the pipes associated with this account. For example,
"NamePrefix": "ABC"
will return all endpoints with "ABC" in the name.
-
nextToken
If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.- Returns:
- If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
-
sourcePrefix
The prefix matching the pipe source.
- Returns:
- The prefix matching the pipe source.
-
targetPrefix
The prefix matching the pipe target.
- Returns:
- The prefix matching the pipe target.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListPipesRequest.Builder,
ListPipesRequest> - Specified by:
toBuilder
in classPipesRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-