Class TestInvokeMethodRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<TestInvokeMethodRequest.Builder,
TestInvokeMethodRequest>
Make a request to simulate the invocation of a Method.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
body()
The simulated request body of an incoming invocation request.builder()
final String
A ClientCertificate identifier to use in the test invocation.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 boolean
For responses, this returns true if the service returned a value for the Headers property.final boolean
For responses, this returns true if the service returned a value for the MultiValueHeaders property.final boolean
For responses, this returns true if the service returned a value for the StageVariables property.headers()
A key-value map of headers to simulate an incoming invocation request.final String
Specifies a test invoke method request's HTTP method.The headers as a map from string to list of values to simulate an incoming invocation request.final String
The URI path, including query string, of the simulated invocation request.final String
Specifies a test invoke method request's resource ID.final String
The string identifier of the associated RestApi.static Class
<? extends TestInvokeMethodRequest.Builder> A key-value map of stage variables to simulate an invocation on a deployed Stage.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
-
restApiId
The string identifier of the associated RestApi.
- Returns:
- The string identifier of the associated RestApi.
-
resourceId
Specifies a test invoke method request's resource ID.
- Returns:
- Specifies a test invoke method request's resource ID.
-
httpMethod
Specifies a test invoke method request's HTTP method.
- Returns:
- Specifies a test invoke method request's HTTP method.
-
pathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- Returns:
- The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
-
body
The simulated request body of an incoming invocation request.
- Returns:
- The simulated request body of an incoming invocation request.
-
hasHeaders
public final boolean hasHeaders()For responses, this returns true if the service returned a value for the Headers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
headers
A key-value map of headers to simulate an incoming invocation request.
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
hasHeaders()
method.- Returns:
- A key-value map of headers to simulate an incoming invocation request.
-
hasMultiValueHeaders
public final boolean hasMultiValueHeaders()For responses, this returns true if the service returned a value for the MultiValueHeaders property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
multiValueHeaders
The headers as a map from string to list of values to simulate an incoming invocation request.
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
hasMultiValueHeaders()
method.- Returns:
- The headers as a map from string to list of values to simulate an incoming invocation request.
-
clientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
- Returns:
- A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
-
hasStageVariables
public final boolean hasStageVariables()For responses, this returns true if the service returned a value for the StageVariables property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
stageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
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
hasStageVariables()
method.- Returns:
- A key-value map of stage variables to simulate an invocation on a deployed Stage.
-
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<TestInvokeMethodRequest.Builder,
TestInvokeMethodRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- 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
-