Class GetEnvironmentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetEnvironmentResponse.Builder,
GetEnvironmentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the Amazon Web Services account where the environment exists.final String
The Amazon Web Services region where the environment exists.builder()
final Instant
The timestamp of when the environment was created.final String
The Amazon DataZone user who created the environment.final DeploymentProperties
The deployment properties of the environment.final String
The description of the environment.final String
domainId()
The ID of the Amazon DataZone domain where the environment exists.The actions of the environment.final String
The blueprint with which the environment is created.final String
The ID of the environment profile with which the environment is created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.The business glossary terms that can be used in this environment.final boolean
For responses, this returns true if the service returned a value for the EnvironmentActions property.final boolean
For responses, this returns true if the service returned a value for the GlossaryTerms property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProvisionedResources property.final boolean
For responses, this returns true if the service returned a value for the UserParameters property.final String
id()
The ID of the environment.final Deployment
The details of the last deployment of the environment.final String
name()
The name of the environment.final String
The ID of the Amazon DataZone project in which this environment is created.final String
provider()
The provider of this Amazon DataZone environment.The provisioned resources of this Amazon DataZone environment.final ProvisioningProperties
The provisioning properties of this Amazon DataZone environment.static Class
<? extends GetEnvironmentResponse.Builder> final EnvironmentStatus
status()
The status of this Amazon DataZone environment.final String
The status of this Amazon DataZone environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The timestamp of when this environment was updated.final List
<CustomParameter> The user parameters of this Amazon DataZone environment.Methods inherited from class software.amazon.awssdk.services.datazone.model.DataZoneResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Web Services region where the environment exists.
- Returns:
- The Amazon Web Services region where the environment exists.
-
createdAt
The timestamp of when the environment was created.
- Returns:
- The timestamp of when the environment was created.
-
createdBy
The Amazon DataZone user who created the environment.
- Returns:
- The Amazon DataZone user who created the environment.
-
deploymentProperties
The deployment properties of the environment.
- Returns:
- The deployment properties of the environment.
-
description
The description of the environment.
- Returns:
- The description of the environment.
-
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 theisEmpty()
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
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
The blueprint with which the environment is created.
- Returns:
- The blueprint with which the environment is created.
-
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 theisEmpty()
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
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
The ID of the environment.
- Returns:
- The ID of the environment.
-
lastDeployment
The details of the last deployment of the environment.
- Returns:
- The details of the last deployment of the environment.
-
name
The name of the environment.
- Returns:
- The name of the environment.
-
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
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 theisEmpty()
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
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
The provisioning properties of this Amazon DataZone environment.
- Returns:
- The provisioning properties of this Amazon DataZone environment.
-
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 returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of this Amazon DataZone environment.
- See Also:
-
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 returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of this Amazon DataZone environment.
- See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<GetEnvironmentResponse.Builder,
GetEnvironmentResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-