Class GetSdkRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.apigateway.model.GetSdkRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class GetSdkRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request a new generated client SDK for a RestApi and Stage.

See Also:

  • Constructor Details

    • GetSdkRequest

      public GetSdkRequest()

  • Method Details

    • setRestApiId

      public void setRestApiId(String restApiId)

      The identifier of the RestApi that the SDK will use.

      Parameters:
      restApiId - The identifier of the RestApi that the SDK will use.

    • getRestApiId

      public String getRestApiId()

      The identifier of the RestApi that the SDK will use.

      Returns:
      The identifier of the RestApi that the SDK will use.

    • withRestApiId

      public GetSdkRequest withRestApiId(String restApiId)

      The identifier of the RestApi that the SDK will use.

      Parameters:
      restApiId - The identifier of the RestApi that the SDK will use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStageName

      public void setStageName(String stageName)

      The name of the Stage that the SDK will use.

      Parameters:
      stageName - The name of the Stage that the SDK will use.

    • getStageName

      public String getStageName()

      The name of the Stage that the SDK will use.

      Returns:
      The name of the Stage that the SDK will use.

    • withStageName

      public GetSdkRequest withStageName(String stageName)

      The name of the Stage that the SDK will use.

      Parameters:
      stageName - The name of the Stage that the SDK will use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setSdkType

      public void setSdkType(String sdkType)

      The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

      Parameters:
      sdkType - The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

    • getSdkType

      public String getSdkType()

      The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

      Returns:
      The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

    • withSdkType

      public GetSdkRequest withSdkType(String sdkType)

      The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

      Parameters:
      sdkType - The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getParameters

      public Map<String,String> getParameters()

      A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.

      Returns:
      A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.

    • setParameters

      public void setParameters(Map<String,String> parameters)

      A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.

      Parameters:
      parameters - A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.

    • withParameters

      public GetSdkRequest withParameters(Map<String,String> parameters)

      A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.

      Parameters:
      parameters - A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addParametersEntry

      public GetSdkRequest addParametersEntry(String key, String value)

    • clearParametersEntries

      public GetSdkRequest clearParametersEntries()
      Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together.

    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public GetSdkRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: