Interface CreateAnalysisRequest.Builder

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

  • Method Details

    • awsAccountId

      CreateAnalysisRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account where you are creating an analysis.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account where you are creating an analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisId

      CreateAnalysisRequest.Builder analysisId(String analysisId)

      The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

      Parameters:
      analysisId - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateAnalysisRequest.Builder name(String name)

      A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.

      Parameters:
      name - A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      CreateAnalysisRequest.Builder parameters(Parameters parameters)

      The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

      Parameters:
      parameters - The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      default CreateAnalysisRequest.Builder parameters(Consumer<Parameters.Builder> parameters)

      The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

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

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

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

    • permissions

      CreateAnalysisRequest.Builder permissions(Collection<ResourcePermission> permissions)

      A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

      Parameters:
      permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateAnalysisRequest.Builder permissions(ResourcePermission... permissions)

      A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

      Parameters:
      permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateAnalysisRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

      A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

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

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

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

    • sourceEntity

      CreateAnalysisRequest.Builder sourceEntity(AnalysisSourceEntity sourceEntity)

      A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Parameters:
      sourceEntity - A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceEntity

      default CreateAnalysisRequest.Builder sourceEntity(Consumer<AnalysisSourceEntity.Builder> sourceEntity)

      A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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

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

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

    • themeArn

      CreateAnalysisRequest.Builder themeArn(String themeArn)

      The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

      Parameters:
      themeArn - The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAnalysisRequest.Builder tags(Collection<Tag> tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAnalysisRequest.Builder tags(Tag... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

      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:

    • definition

      CreateAnalysisRequest.Builder definition(AnalysisDefinition definition)

      The definition of an analysis.

      A definition is the data model of all features in a Dashboard, Template, or Analysis.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Parameters:
      definition - The definition of an analysis.

      A definition is the data model of all features in a Dashboard, Template, or Analysis.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      default CreateAnalysisRequest.Builder definition(Consumer<AnalysisDefinition.Builder> definition)

      The definition of an analysis.

      A definition is the data model of all features in a Dashboard, Template, or Analysis.

      Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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

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

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

    • validationStrategy

      CreateAnalysisRequest.Builder validationStrategy(ValidationStrategy validationStrategy)

      The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

      Parameters:
      validationStrategy - The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationStrategy

      default CreateAnalysisRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)

      The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

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

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

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

    • folderArns

      CreateAnalysisRequest.Builder folderArns(Collection<String> folderArns)

      When you create the analysis, Amazon Quick Sight adds the analysis to these folders.

      Parameters:
      folderArns - When you create the analysis, Amazon Quick Sight adds the analysis to these folders.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • folderArns

      CreateAnalysisRequest.Builder folderArns(String... folderArns)

      When you create the analysis, Amazon Quick Sight adds the analysis to these folders.

      Parameters:
      folderArns - When you create the analysis, Amazon Quick Sight adds the analysis to these folders.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateAnalysisRequest.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

      CreateAnalysisRequest.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.