Class Connector

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

An object that represents a connector for an Amazon EVS environment. A connector establishes a vCenter connection using the credentials stored in Amazon Web Services Secrets Manager.

See Also:

  • Method Details

    • environmentId

      public final String environmentId()

      The unique ID of the environment that the connector belongs to.

      Returns:
      The unique ID of the environment that the connector belongs to.

    • connectorId

      public final String connectorId()

      The unique ID of the connector.

      Returns:
      The unique ID of the connector.

    • type

      public final ConnectorType type()

      The type of the connector.

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

      Returns:
      The type of the connector.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the connector.

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

      Returns:
      The type of the connector.
      See Also:

    • applianceFqdn

      public final String applianceFqdn()

      The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

      Returns:
      The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

    • secretArn

      public final String secretArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

    • state

      public final ConnectorState state()

      The state of the connector.

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

      Returns:
      The state of the connector.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the connector.

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

      Returns:
      The state of the connector.
      See Also:

    • stateDetails

      public final String stateDetails()

      A detailed description of the connector state.

      Returns:
      A detailed description of the connector state.

    • status

      public final CheckResult status()

      The status of the connector.

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

      Returns:
      The status of the connector.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the connector.

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

      Returns:
      The status of the connector.
      See Also:

    • hasChecks

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

    • checks

      public final List<ConnectorCheck> checks()

      A list of checks that are run on the connector.

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

      Returns:
      A list of checks that are run on the connector.

    • createdAt

      public final Instant createdAt()

      The date and time that the connector was created.

      Returns:
      The date and time that the connector was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time that the connector was modified.

      Returns:
      The date and time that the connector was modified.

    • toBuilder

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

    • builder

      public static Connector.Builder builder()

    • serializableBuilderClass

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