Class CreateActionConnectorRequest

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID associated with the action connector.

      Returns:
      The Amazon Web Services account ID associated with the action connector.

    • actionConnectorId

      public final String actionConnectorId()

      A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-

      Returns:
      A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-

    • name

      public final String name()

      A descriptive name for the action connector.

      Returns:
      A descriptive name for the action connector.

    • type

      public final ActionConnectorType type()

      The type of action connector.

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

      Returns:
      The type of action connector.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of action connector.

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

      Returns:
      The type of action connector.
      See Also:

    • authenticationConfig

      public final AuthConfig authenticationConfig()

      The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

      Returns:
      The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

    • description

      public final String description()

      An optional description of the action connector.

      Returns:
      An optional description of the action connector.

    • hasPermissions

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

    • permissions

      public final List<ResourcePermission> permissions()

      The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

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

      Returns:
      The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

    • vpcConnectionArn

      public final String vpcConnectionArn()

      The ARN of the VPC connection to use for secure connectivity to the external service.

      Returns:
      The ARN of the VPC connection to use for secure connectivity to the external service.

    • 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 List<Tag> tags()

      A list of tags to apply to the action connector for resource management and organization.

      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:
      A list of tags to apply to the action connector for resource management and organization.

    • toBuilder

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

    • builder

      public static CreateActionConnectorRequest.Builder builder()

    • serializableBuilderClass

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