Class GetEnvironmentResponse

    • Method Detail

      • 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.
      • 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:
        EnvironmentStatus
      • 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.
      • 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