Class CreateOdbNetworkRequest

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.CreateOdbNetworkRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateOdbNetworkRequest.Builder,CreateOdbNetworkRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOdbNetworkRequest extends OdbRequest implements ToCopyableBuilder<CreateOdbNetworkRequest.Builder,CreateOdbNetworkRequest>

  • Method Details

    • displayName

      public final String displayName()

      A user-friendly name for the ODB network.

      Returns:
      A user-friendly name for the ODB network.

    • availabilityZone

      public final String availabilityZone()

      The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

      This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

      Returns:
      The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

      This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

    • availabilityZoneId

      public final String availabilityZoneId()

      The AZ ID of the AZ where the ODB network is located.

      This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

      Returns:
      The AZ ID of the AZ where the ODB network is located.

      This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

    • clientSubnetCidr

      public final String clientSubnetCidr()

      The CIDR range of the client subnet for the ODB network.

      Constraints:

      • Must not overlap with the CIDR range of the backup subnet.

      • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

      • Must not use the following CIDR ranges that are reserved by OCI:

        • 100.106.0.0/16 and 100.107.0.0/16

        • 169.254.0.0/16

        • 224.0.0.0 - 239.255.255.255

        • 240.0.0.0 - 255.255.255.255

      Returns:
      The CIDR range of the client subnet for the ODB network.

      Constraints:

      • Must not overlap with the CIDR range of the backup subnet.

      • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

      • Must not use the following CIDR ranges that are reserved by OCI:

        • 100.106.0.0/16 and 100.107.0.0/16

        • 169.254.0.0/16

        • 224.0.0.0 - 239.255.255.255

        • 240.0.0.0 - 255.255.255.255

    • backupSubnetCidr

      public final String backupSubnetCidr()

      The CIDR range of the backup subnet for the ODB network.

      Constraints:

      • Must not overlap with the CIDR range of the client subnet.

      • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

      • Must not use the following CIDR ranges that are reserved by OCI:

        • 100.106.0.0/16 and 100.107.0.0/16

        • 169.254.0.0/16

        • 224.0.0.0 - 239.255.255.255

        • 240.0.0.0 - 255.255.255.255

      Returns:
      The CIDR range of the backup subnet for the ODB network.

      Constraints:

      • Must not overlap with the CIDR range of the client subnet.

      • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

      • Must not use the following CIDR ranges that are reserved by OCI:

        • 100.106.0.0/16 and 100.107.0.0/16

        • 169.254.0.0/16

        • 224.0.0.0 - 239.255.255.255

        • 240.0.0.0 - 255.255.255.255

    • customDomainName

      public final String customDomainName()

      The domain name to use for the resources in the ODB network.

      Returns:
      The domain name to use for the resources in the ODB network.

    • defaultDnsPrefix

      public final String defaultDnsPrefix()

      The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

      Returns:
      The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

    • s3Access

      public final Access s3Access()

      Specifies the 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 configuration for Amazon S3 access from the ODB network.
      See Also:

    • s3AccessAsString

      public final String s3AccessAsString()

      Specifies the 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 configuration for Amazon S3 access from the ODB network.
      See Also:

    • zeroEtlAccess

      public final Access zeroEtlAccess()

      Specifies the 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 configuration for Zero-ETL access from the ODB network.
      See Also:

    • zeroEtlAccessAsString

      public final String zeroEtlAccessAsString()

      Specifies the 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 configuration for Zero-ETL access from the ODB network.
      See Also:

    • s3PolicyDocument

      public final String s3PolicyDocument()

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

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

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The list of resource tags to apply 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 hasTags() method.

      Returns:
      The list of resource tags to apply to the ODB network.

    • toBuilder

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

    • builder

      public static CreateOdbNetworkRequest.Builder builder()

    • serializableBuilderClass

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