Class UpdateDeploymentRequest

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

  • Method Details

    • deploymentIdentifier

      public final String deploymentIdentifier()

      The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).

      Returns:
      The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).

    • updateToken

      public final String updateToken()

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

      Returns:
      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

    • deploymentDescription

      public final String deploymentDescription()

      A description of the deployment.

      Returns:
      A description of the deployment.

    • deploymentConfiguration

      public final DeploymentConfiguration deploymentConfiguration()

      The configuration settings for the deployment.

      Returns:
      The configuration settings for the deployment.

    • hasAssociatedPolicyList

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

    • associatedPolicyList

      public final List<PolicyReference> associatedPolicyList()

      The policies associated with the deployment.

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

      Returns:
      The policies associated with the deployment.

    • hasAssociatedScopeList

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

    • associatedScopeList

      public final List<ScopeReference> associatedScopeList()

      The scope associated with the deployment. A deployment has exactly one scope.

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

      Returns:
      The scope associated with the deployment. A deployment has exactly one scope.

    • isPublished

      public final Boolean isPublished()

      Specifies whether to publish the resource. When true, the resource is saved in published ( ACTIVE) state. When false, it is saved as a draft (DRAFT).

      Returns:
      Specifies whether to publish the resource. When true, the resource is saved in published ( ACTIVE) state. When false, it is saved as a draft (DRAFT).

    • clientToken

      public final String clientToken()

      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

      Returns:
      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

    • toBuilder

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

    • builder

      public static UpdateDeploymentRequest.Builder builder()

    • serializableBuilderClass

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