Package software.amazon.awssdk.services.appsync.model

Class PutGraphqlApiEnvironmentVariablesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.appsync.model.AppSyncRequest
software.amazon.awssdk.services.appsync.model.PutGraphqlApiEnvironmentVariablesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutGraphqlApiEnvironmentVariablesRequest.Builder,PutGraphqlApiEnvironmentVariablesRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutGraphqlApiEnvironmentVariablesRequest extends AppSyncRequest implements ToCopyableBuilder<PutGraphqlApiEnvironmentVariablesRequest.Builder,PutGraphqlApiEnvironmentVariablesRequest>

  • Method Details

    • apiId

      public final String apiId()

      The ID of the API to which the environmental variable list will be written.

      Returns:
      The ID of the API to which the environmental variable list will be written.

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables 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.

    • environmentVariables

      public final Map<String,String> environmentVariables()

      The list of environmental variables to add to the API.

      When creating an environmental variable key-value pair, it must follow the additional constraints below:

      • Keys must begin with a letter.

      • Keys must be at least two characters long.

      • Keys can only contain letters, numbers, and the underscore character (_).

      • Values can be up to 512 characters long.

      • You can configure up to 50 key-value pairs in a GraphQL API.

      You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

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

      Returns:
      The list of environmental variables to add to the API.

      When creating an environmental variable key-value pair, it must follow the additional constraints below:

      • Keys must begin with a letter.

      • Keys must be at least two characters long.

      • Keys can only contain letters, numbers, and the underscore character (_).

      • Values can be up to 512 characters long.

      • You can configure up to 50 key-value pairs in a GraphQL API.

      You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

    • toBuilder

      public PutGraphqlApiEnvironmentVariablesRequest.Builder 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 interface ToCopyableBuilder<PutGraphqlApiEnvironmentVariablesRequest.Builder,PutGraphqlApiEnvironmentVariablesRequest>
      Specified by:
      toBuilder in class AppSyncRequest
      Returns:
      a builder for type T

    • builder

      public static PutGraphqlApiEnvironmentVariablesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutGraphqlApiEnvironmentVariablesRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.