Package software.amazon.awscdk.integtests.alpha

Class AwsApiCallRequest.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.integtests.alpha.AwsApiCallRequest.Jsii$Proxy
All Implemented Interfaces:
AwsApiCallRequest, software.amazon.jsii.JsiiSerializable
Enclosing interface:
AwsApiCallRequest
@Stability(Experimental) @Internal public static final class AwsApiCallRequest.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AwsApiCallRequest
An implementation for AwsApiCallRequest

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.integtests.alpha.AwsApiCallRequest

    AwsApiCallRequest.Builder, AwsApiCallRequest.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(AwsApiCallRequest.Builder builder)
    Constructor that initializes the object based on literal property values passed by the AwsApiCallRequest.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getApi()
    (experimental) The AWS api call to make i.e.
    final String
    getFlattenResponse()
    (experimental) Whether or not to flatten the response from the api call.
    final List<String>
    getOutputPaths()
    (experimental) Restrict the data returned by the API call to specific paths in the API response.
    final Object
    getParameters()
    (experimental) Any parameters to pass to the api call.
    final String
    getService()
    (experimental) The AWS service i.e.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(AwsApiCallRequest.Builder builder)
      Constructor that initializes the object based on literal property values passed by the AwsApiCallRequest.Builder.

  • Method Details

    • getApi

      public final String getApi()
      Description copied from interface: AwsApiCallRequest
      (experimental) The AWS api call to make i.e. getBucketLifecycle.
      Specified by:
      getApi in interface AwsApiCallRequest

    • getService

      public final String getService()
      Description copied from interface: AwsApiCallRequest
      (experimental) The AWS service i.e. S3.
      Specified by:
      getService in interface AwsApiCallRequest

    • getFlattenResponse

      public final String getFlattenResponse()
      Description copied from interface: AwsApiCallRequest
      (experimental) Whether or not to flatten the response from the api call.

      Valid values are 'true' or 'false' as strings

      Typically when using an SdkRequest you will be passing it as the actual value to an assertion provider so this would be set to 'false' (you want the actual response).

      If you are using the SdkRequest to perform more of a query to return a single value to use, then this should be set to 'true'. For example, you could make a StepFunctions.startExecution api call and retreive the executionArn from the response.

      Default: 'false'

      Specified by:
      getFlattenResponse in interface AwsApiCallRequest

    • getOutputPaths

      public final List<String> getOutputPaths()
      Description copied from interface: AwsApiCallRequest
      (experimental) Restrict the data returned by the API call to specific paths in the API response.

      Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

      Default: - return all data

      Specified by:
      getOutputPaths in interface AwsApiCallRequest

    • getParameters

      public final Object getParameters()
      Description copied from interface: AwsApiCallRequest
      (experimental) Any parameters to pass to the api call.

      Default: - no parameters

      Specified by:
      getParameters in interface AwsApiCallRequest

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object