Interface CreatePluginRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePluginRequest.Builder,CreatePluginRequest>, QBusinessRequest.Builder, SdkBuilder<CreatePluginRequest.Builder,CreatePluginRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePluginRequest
@Mutable @NotThreadSafe public static interface CreatePluginRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreatePluginRequest.Builder,CreatePluginRequest>

  • Method Details

    • applicationId

      CreatePluginRequest.Builder applicationId(String applicationId)

      The identifier of the application that will contain the plugin.

      Parameters:
      applicationId - The identifier of the application that will contain the plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      CreatePluginRequest.Builder displayName(String displayName)

      A the name for your plugin.

      Parameters:
      displayName - A the name for your plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreatePluginRequest.Builder type(String type)

      The type of plugin you want to create.

      Parameters:
      type - The type of plugin you want to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreatePluginRequest.Builder type(PluginType type)

      The type of plugin you want to create.

      Parameters:
      type - The type of plugin you want to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authConfiguration

      CreatePluginRequest.Builder authConfiguration(PluginAuthConfiguration authConfiguration)
      Sets the value of the AuthConfiguration property for this object.
      Parameters:
      authConfiguration - The new value for the AuthConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authConfiguration

      default CreatePluginRequest.Builder authConfiguration(Consumer<PluginAuthConfiguration.Builder> authConfiguration)
      Sets the value of the AuthConfiguration property for this object. This is a convenience method that creates an instance of the PluginAuthConfiguration.Builder avoiding the need to create one manually via PluginAuthConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authConfiguration(PluginAuthConfiguration).

      Parameters:
      authConfiguration - a consumer that will call methods on PluginAuthConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverUrl

      CreatePluginRequest.Builder serverUrl(String serverUrl)

      The source URL used for plugin configuration.

      Parameters:
      serverUrl - The source URL used for plugin configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPluginConfiguration

      CreatePluginRequest.Builder customPluginConfiguration(CustomPluginConfiguration customPluginConfiguration)

      Contains configuration for a custom plugin.

      Parameters:
      customPluginConfiguration - Contains configuration for a custom plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPluginConfiguration

      default CreatePluginRequest.Builder customPluginConfiguration(Consumer<CustomPluginConfiguration.Builder> customPluginConfiguration)

      Contains configuration for a custom plugin.

      This is a convenience method that creates an instance of the CustomPluginConfiguration.Builder avoiding the need to create one manually via CustomPluginConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customPluginConfiguration(CustomPluginConfiguration).

      Parameters:
      customPluginConfiguration - a consumer that will call methods on CustomPluginConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreatePluginRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      Parameters:
      tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePluginRequest.Builder tags(Tag... tags)

      A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      Parameters:
      tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePluginRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreatePluginRequest.Builder clientToken(String clientToken)

      A token that you provide to identify the request to create your Amazon Q Business plugin.

      Parameters:
      clientToken - A token that you provide to identify the request to create your Amazon Q Business plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePluginRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePluginRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.