Class UpdateOdbNetworkRequest

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

  • Method Details

    • odbNetworkId

      public final String odbNetworkId()

      The unique identifier of the ODB network to update.

      Returns:
      The unique identifier of the ODB network to update.

    • displayName

      public final String displayName()

      The new user-friendly name of the ODB network.

      Returns:
      The new user-friendly name of the ODB network.

    • hasPeeredCidrsToBeAdded

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

    • peeredCidrsToBeAdded

      public final List<String> peeredCidrsToBeAdded()

      The list of CIDR ranges from the peered VPC that allow access to the ODB network.

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

      Returns:
      The list of CIDR ranges from the peered VPC that allow access to the ODB network.

    • hasPeeredCidrsToBeRemoved

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

    • peeredCidrsToBeRemoved

      public final List<String> peeredCidrsToBeRemoved()

      The list of CIDR ranges from the peered VPC to remove from the ODB network.

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

      Returns:
      The list of CIDR ranges from the peered VPC to remove from the ODB network.

    • s3Access

      public final Access s3Access()

      Specifies the updated configuration for Amazon S3 access from the ODB network.

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

      Returns:
      Specifies the updated configuration for Amazon S3 access from the ODB network.
      See Also:

    • s3AccessAsString

      public final String s3AccessAsString()

      Specifies the updated configuration for Amazon S3 access from the ODB network.

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

      Returns:
      Specifies the updated configuration for Amazon S3 access from the ODB network.
      See Also:

    • zeroEtlAccess

      public final Access zeroEtlAccess()

      Specifies the updated configuration for Zero-ETL access from the ODB network.

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

      Returns:
      Specifies the updated configuration for Zero-ETL access from the ODB network.
      See Also:

    • zeroEtlAccessAsString

      public final String zeroEtlAccessAsString()

      Specifies the updated configuration for Zero-ETL access from the ODB network.

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

      Returns:
      Specifies the updated configuration for Zero-ETL access from the ODB network.
      See Also:

    • stsAccess

      public final Access stsAccess()

      The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

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

      Returns:
      The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
      See Also:

    • stsAccessAsString

      public final String stsAccessAsString()

      The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

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

      Returns:
      The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
      See Also:

    • kmsAccess

      public final Access kmsAccess()

      The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

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

      Returns:
      The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
      See Also:

    • kmsAccessAsString

      public final String kmsAccessAsString()

      The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

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

      Returns:
      The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
      See Also:

    • s3PolicyDocument

      public final String s3PolicyDocument()

      Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

      Returns:
      Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

    • stsPolicyDocument

      public final String stsPolicyDocument()

      The STS policy document that defines permissions for token service usage within the ODB network.

      Returns:
      The STS policy document that defines permissions for token service usage within the ODB network.

    • kmsPolicyDocument

      public final String kmsPolicyDocument()

      The KMS policy document that defines permissions for key usage within the ODB network.

      Returns:
      The KMS policy document that defines permissions for key usage within the ODB network.

    • hasCrossRegionS3RestoreSourcesToEnable

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

    • crossRegionS3RestoreSourcesToEnable

      public final List<String> crossRegionS3RestoreSourcesToEnable()

      The cross-Region Amazon S3 restore sources to enable for the ODB network.

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

      Returns:
      The cross-Region Amazon S3 restore sources to enable for the ODB network.

    • hasCrossRegionS3RestoreSourcesToDisable

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

    • crossRegionS3RestoreSourcesToDisable

      public final List<String> crossRegionS3RestoreSourcesToDisable()

      The cross-Region Amazon S3 restore sources to disable for the ODB network.

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

      Returns:
      The cross-Region Amazon S3 restore sources to disable for the ODB network.

    • toBuilder

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

    • builder

      public static UpdateOdbNetworkRequest.Builder builder()

    • serializableBuilderClass

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