Class UpdateAnalysisRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateAnalysisRequest extends QuickSightRequest implements ToCopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>
  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that contains the analysis that you're updating.

      Returns:
      The ID of the Amazon Web Services account that contains the analysis that you're updating.
    • analysisId

      public final String analysisId()

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

      Returns:
      The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
    • name

      public final String name()

      A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

      Returns:
      A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
    • parameters

      public final 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:
      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.
    • sourceEntity

      public final AnalysisSourceEntity sourceEntity()

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

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

      public final String themeArn()

      The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

      Returns:
      The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
    • definition

      public final AnalysisDefinition definition()

      The definition of an analysis.

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

      Returns:
      The definition of an analysis.

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

    • validationStrategy

      public final ValidationStrategy validationStrategy()

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

      Returns:
      The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.
    • toBuilder

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

      public static UpdateAnalysisRequest.Builder builder()
    • serializableBuilderClass

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