Class RegisterConnectorRequest

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

  • Method Details

    • connectorLabel

      public final String connectorLabel()

      The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

      Returns:
      The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

    • description

      public final String description()

      A description about the connector that's being registered.

      Returns:
      A description about the connector that's being registered.

    • connectorProvisioningType

      public final ConnectorProvisioningType connectorProvisioningType()

      The provisioning type of the connector. Currently the only supported value is LAMBDA.

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

      Returns:
      The provisioning type of the connector. Currently the only supported value is LAMBDA.
      See Also:

    • connectorProvisioningTypeAsString

      public final String connectorProvisioningTypeAsString()

      The provisioning type of the connector. Currently the only supported value is LAMBDA.

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

      Returns:
      The provisioning type of the connector. Currently the only supported value is LAMBDA.
      See Also:

    • connectorProvisioningConfig

      public final ConnectorProvisioningConfig connectorProvisioningConfig()

      The provisioning type of the connector. Currently the only supported value is LAMBDA.

      Returns:
      The provisioning type of the connector. Currently the only supported value is LAMBDA.

    • clientToken

      public final String clientToken()

      The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.

      Returns:
      The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.

    • toBuilder

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

    • builder

      public static RegisterConnectorRequest.Builder builder()

    • serializableBuilderClass

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