Class CreateEnvironmentConnectorRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Returns:

      This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

    • environmentId

      public final String environmentId()

      A unique ID for the environment to create the connector in.

      Returns:
      A unique ID for the environment to create the connector in.

    • type

      public final ConnectorType type()

      The type of connector to create.

      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 connector to create.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of connector to create.

      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 connector to create.
      See Also:

    • applianceFqdn

      public final String applianceFqdn()

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

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

    • secretIdentifier

      public final String secretIdentifier()

      The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

      Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions.

      Returns:
      The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

      Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions.

    • toBuilder

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

    • builder

      public static CreateEnvironmentConnectorRequest.Builder builder()

    • serializableBuilderClass

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