Class OdbNetworkSummary

java.lang.Object
software.amazon.awssdk.services.odb.model.OdbNetworkSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OdbNetworkSummary.Builder,OdbNetworkSummary>
@Generated("software.amazon.awssdk:codegen") public final class OdbNetworkSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OdbNetworkSummary.Builder,OdbNetworkSummary>

Information about an ODB network.

See Also:

  • Method Details

    • odbNetworkId

      public final String odbNetworkId()

      The unique identifier of the ODB network.

      Returns:
      The unique identifier of the ODB network.

    • displayName

      public final String displayName()

      The user-friendly name of the ODB network.

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

    • status

      public final ResourceStatus status()

      The current status of the ODB network.

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

      Returns:
      The current status of the ODB network.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the ODB network.

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

      Returns:
      The current status of the ODB network.
      See Also:

    • statusReason

      public final String statusReason()

      Additional information about the current status of the ODB network.

      Returns:
      Additional information about the current status of the ODB network.

    • odbNetworkArn

      public final String odbNetworkArn()

      The Amazon Resource Name (ARN) of the ODB network.

      Returns:
      The Amazon Resource Name (ARN) of the ODB network.

    • availabilityZone

      public final String availabilityZone()

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

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

    • availabilityZoneId

      public final String availabilityZoneId()

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

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

    • clientSubnetCidr

      public final String clientSubnetCidr()

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

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

    • backupSubnetCidr

      public final String backupSubnetCidr()

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

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

    • customDomainName

      public final String customDomainName()

      The domain name for the resources in the ODB network.

      Returns:
      The domain name 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.

    • hasPeeredCidrs

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

    • peeredCidrs

      public final List<String> peeredCidrs()

      The list of CIDR ranges from the peered VPC that are allowed 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 hasPeeredCidrs() method.

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

    • ociNetworkAnchorId

      public final String ociNetworkAnchorId()

      The unique identifier of the OCI network anchor for the ODB network.

      Returns:
      The unique identifier of the OCI network anchor for the ODB network.

    • ociNetworkAnchorUrl

      public final String ociNetworkAnchorUrl()

      The URL of the OCI network anchor for the ODB network.

      Returns:
      The URL of the OCI network anchor for the ODB network.

    • ociResourceAnchorName

      public final String ociResourceAnchorName()

      The name of the OCI resource anchor associated with the ODB network.

      Returns:
      The name of the OCI resource anchor associated with the ODB network.

    • ociVcnId

      public final String ociVcnId()

      The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) associated with the ODB network.

      Returns:
      The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) associated with the ODB network.

    • ociVcnUrl

      public final String ociVcnUrl()

      The URL for the VCN that's associated with the ODB network.

      Returns:
      The URL for the VCN that's associated with the ODB network.

    • hasOciDnsForwardingConfigs

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

    • ociDnsForwardingConfigs

      public final List<OciDnsForwardingConfig> ociDnsForwardingConfigs()

      The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.

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

      Returns:
      The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.

    • createdAt

      public final Instant createdAt()

      The date and time when the ODB network was created.

      Returns:
      The date and time when the ODB network was created.

    • percentProgress

      public final Float percentProgress()

      The amount of progress made on the current operation on the ODB network, expressed as a percentage.

      Returns:
      The amount of progress made on the current operation on the ODB network, expressed as a percentage.

    • managedServices

      public final ManagedServices managedServices()

      The managed services configuration for the ODB network.

      Returns:
      The managed services configuration for the ODB network.

    • toBuilder

      public OdbNetworkSummary.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<OdbNetworkSummary.Builder,OdbNetworkSummary>
      Returns:
      a builder for type T

    • builder

      public static OdbNetworkSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OdbNetworkSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.