Class UpdateEnvironmentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateEnvironmentResponse.Builder,
UpdateEnvironmentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Web Services account in which the environment is to be updated.final String
The Amazon Web Services Region in which the environment is updated.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 to be updated as part of theUpdateEnvironment
action.final String
The description to be updated as part of theUpdateEnvironment
action.final String
domainId()
The identifier of the domain in which the environment is to be updated.The environment actions to be updated as part of theUpdateEnvironment
action.final String
The blueprint identifier of the environment.final String
The profile identifier of the environment.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 glossary terms to be updated as part of theUpdateEnvironment
action.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 identifier of the environment that is to be updated.final Deployment
The last deployment of the environment.final String
name()
The name to be updated as part of theUpdateEnvironment
action.final String
The project identifier of the environment.final String
provider()
The provider identifier of the environment.The provisioned resources to be updated as part of theUpdateEnvironment
action.final ProvisioningProperties
The provisioning properties to be updated as part of theUpdateEnvironment
action.static Class
<? extends UpdateEnvironmentResponse.Builder> final EnvironmentStatus
status()
The status to be updated as part of theUpdateEnvironment
action.final String
The status to be updated as part of theUpdateEnvironment
action.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 the environment was updated.final List
<CustomParameter> The user parameters to be updated as part of theUpdateEnvironment
action.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 identifier of the Amazon Web Services account in which the environment is to be updated.
- Returns:
- The identifier of the Amazon Web Services account in which the environment is to be updated.
-
awsAccountRegion
The Amazon Web Services Region in which the environment is updated.
- Returns:
- The Amazon Web Services Region in which the environment is updated.
-
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 to be updated as part of the
UpdateEnvironment
action.- Returns:
- The deployment properties to be updated as part of the
UpdateEnvironment
action.
-
description
The description to be updated as part of the
UpdateEnvironment
action.- Returns:
- The description to be updated as part of the
UpdateEnvironment
action.
-
domainId
The identifier of the domain in which the environment is to be updated.
- Returns:
- The identifier of the domain in which the environment is to be updated.
-
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 environment actions to be updated as part of the
UpdateEnvironment
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
hasEnvironmentActions()
method.- Returns:
- The environment actions to be updated as part of the
UpdateEnvironment
action.
-
environmentBlueprintId
The blueprint identifier of the environment.
- Returns:
- The blueprint identifier of the environment.
-
environmentProfileId
The profile identifier of the environment.
- Returns:
- The profile identifier of the 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 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 glossary terms to be updated as part of the
UpdateEnvironment
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
hasGlossaryTerms()
method.- Returns:
- The glossary terms to be updated as part of the
UpdateEnvironment
action.
-
id
The identifier of the environment that is to be updated.
- Returns:
- The identifier of the environment that is to be updated.
-
lastDeployment
The last deployment of the environment.
- Returns:
- The last deployment of the environment.
-
name
The name to be updated as part of the
UpdateEnvironment
action.- Returns:
- The name to be updated as part of the
UpdateEnvironment
action.
-
projectId
The project identifier of the environment.
- Returns:
- The project identifier of the environment.
-
provider
The provider identifier of the environment.
- Returns:
- The provider identifier of the 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 to be updated as part of the
UpdateEnvironment
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
hasProvisionedResources()
method.- Returns:
- The provisioned resources to be updated as part of the
UpdateEnvironment
action.
-
provisioningProperties
The provisioning properties to be updated as part of the
UpdateEnvironment
action.- Returns:
- The provisioning properties to be updated as part of the
UpdateEnvironment
action.
-
status
The status to be updated as part of the
UpdateEnvironment
action.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 to be updated as part of the
UpdateEnvironment
action. - See Also:
-
statusAsString
The status to be updated as part of the
UpdateEnvironment
action.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 to be updated as part of the
UpdateEnvironment
action. - See Also:
-
updatedAt
The timestamp of when the environment was updated.
- Returns:
- The timestamp of when the 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 to be updated as part of the
UpdateEnvironment
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
hasUserParameters()
method.- Returns:
- The user parameters to be updated as part of the
UpdateEnvironment
action.
-
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<UpdateEnvironmentResponse.Builder,
UpdateEnvironmentResponse> - 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
-