Package software.amazon.awssdk.services.alexaforbusiness.model

Class UpdateBusinessReportScheduleRequest

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

  • Method Details

    • scheduleArn

      public final String scheduleArn()

      The ARN of the business report schedule.

      Returns:
      The ARN of the business report schedule.

    • s3BucketName

      public final String s3BucketName()

      The S3 location of the output reports.

      Returns:
      The S3 location of the output reports.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      The S3 key where the report is delivered.

      Returns:
      The S3 key where the report is delivered.

    • format

      public final BusinessReportFormat format()

      The format of the generated report (individual CSV files or zipped files of individual files).

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

      Returns:
      The format of the generated report (individual CSV files or zipped files of individual files).
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the generated report (individual CSV files or zipped files of individual files).

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

      Returns:
      The format of the generated report (individual CSV files or zipped files of individual files).
      See Also:

    • scheduleName

      public final String scheduleName()

      The name identifier of the schedule.

      Returns:
      The name identifier of the schedule.

    • recurrence

      public final BusinessReportRecurrence recurrence()

      The recurrence of the reports.

      Returns:
      The recurrence of the reports.

    • toBuilder

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

    • builder

      public static UpdateBusinessReportScheduleRequest.Builder builder()

    • serializableBuilderClass

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