Class CreateEnvironmentRequest

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

  • Method Details

    • deploymentOrder

      public final Integer deploymentOrder()

      The deployment order of the environment.

      Returns:
      The deployment order of the environment.

    • description

      public final String description()

      The description of the Amazon DataZone environment.

      Returns:
      The description of the Amazon DataZone environment.

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon DataZone domain in which the environment is created.

      Returns:
      The identifier of the Amazon DataZone domain in which the environment is created.

    • environmentAccountIdentifier

      public final String environmentAccountIdentifier()

      The ID of the account in which the environment is being created.

      Returns:
      The ID of the account in which the environment is being created.

    • environmentAccountRegion

      public final String environmentAccountRegion()

      The region of the account in which the environment is being created.

      Returns:
      The region of the account in which the environment is being created.

    • environmentBlueprintIdentifier

      public final String environmentBlueprintIdentifier()

      The ID of the blueprint with which the environment is being created.

      Returns:
      The ID of the blueprint with which the environment is being created.

    • environmentConfigurationId

      public final String environmentConfigurationId()

      The configuration ID of the environment.

      Returns:
      The configuration ID of the environment.

    • environmentProfileIdentifier

      public final String environmentProfileIdentifier()

      The identifier of the environment profile that is used to create this Amazon DataZone environment.

      Returns:
      The identifier of the environment profile that is used to create this Amazon DataZone environment.

    • hasGlossaryTerms

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

    • glossaryTerms

      public final List<String> glossaryTerms()

      The glossary terms that can be used in this Amazon DataZone environment.

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

      Returns:
      The glossary terms that can be used in this Amazon DataZone environment.

    • name

      public final String name()

      The name of the Amazon DataZone environment.

      Returns:
      The name of the Amazon DataZone environment.

    • projectIdentifier

      public final String projectIdentifier()

      The identifier of the Amazon DataZone project in which this environment is created.

      Returns:
      The identifier of the Amazon DataZone project in which this environment is created.

    • hasUserParameters

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

    • userParameters

      public final List<EnvironmentParameter> userParameters()

      The user parameters of this Amazon DataZone environment.

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

      Returns:
      The user parameters of this Amazon DataZone environment.

    • toBuilder

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

    • builder

      public static CreateEnvironmentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEnvironmentRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.