Class GetEnvironmentResponse

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account where the environment exists.

      Returns:
      The ID of the Amazon Web Services account where the environment exists.

    • awsAccountRegion

      public final String awsAccountRegion()

      The Amazon Web Services region where the environment exists.

      Returns:
      The Amazon Web Services region where the environment exists.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the environment was created.

      Returns:
      The timestamp of when the environment was created.

    • createdBy

      public final String createdBy()

      The Amazon DataZone user who created the environment.

      Returns:
      The Amazon DataZone user who created the environment.

    • deploymentProperties

      public final DeploymentProperties deploymentProperties()

      The deployment properties of the environment.

      Returns:
      The deployment properties of the environment.

    • description

      public final String description()

      The description of the environment.

      Returns:
      The description of the environment.

    • domainId

      public final String domainId()

      The ID of the Amazon DataZone domain where the environment exists.

      Returns:
      The ID of the Amazon DataZone domain where the environment exists.

    • hasEnvironmentActions

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

    • environmentActions

      public final List<ConfigurableEnvironmentAction> environmentActions()

      The actions of the 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 hasEnvironmentActions() method.

      Returns:
      The actions of the environment.

    • environmentBlueprintId

      public final String environmentBlueprintId()

      The blueprint with which the environment is created.

      Returns:
      The blueprint with which the environment is created.

    • environmentProfileId

      public final String environmentProfileId()

      The ID of the environment profile with which the environment is created.

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

    • 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 business glossary terms that can be used in this 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 business glossary terms that can be used in this environment.

    • id

      public final String id()

      The ID of the environment.

      Returns:
      The ID of the environment.

    • lastDeployment

      public final Deployment lastDeployment()

      The details of the last deployment of the environment.

      Returns:
      The details of the last deployment of the environment.

    • name

      public final String name()

      The name of the environment.

      Returns:
      The name of the environment.

    • projectId

      public final String projectId()

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

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

    • provider

      public final String provider()

      The provider of this Amazon DataZone environment.

      Returns:
      The provider of this Amazon DataZone environment.

    • hasProvisionedResources

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

    • provisionedResources

      public final List<Resource> provisionedResources()

      The provisioned resources 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 hasProvisionedResources() method.

      Returns:
      The provisioned resources of this Amazon DataZone environment.

    • provisioningProperties

      public final ProvisioningProperties provisioningProperties()

      The provisioning properties of this Amazon DataZone environment.

      Returns:
      The provisioning properties of this Amazon DataZone environment.

    • status

      public final EnvironmentStatus status()

      The status of this Amazon DataZone environment.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of this Amazon DataZone environment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of this Amazon DataZone environment.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of this Amazon DataZone environment.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when this environment was updated.

      Returns:
      The timestamp of when this environment was updated.

    • 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<CustomParameter> 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 GetEnvironmentResponse.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<GetEnvironmentResponse.Builder,GetEnvironmentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEnvironmentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEnvironmentResponse.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

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