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

Class CreateBusinessReportScheduleRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBusinessReportScheduleRequest.Builder,CreateBusinessReportScheduleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBusinessReportScheduleRequest
extends AlexaForBusinessRequest
implements ToCopyableBuilder<CreateBusinessReportScheduleRequest.Builder,CreateBusinessReportScheduleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBusinessReportScheduleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateBusinessReportScheduleRequest.Builder	builder()
String	clientRequestToken()	The client request token.
BusinessReportContentRange	contentRange()	The content range of the reports.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
BusinessReportFormat	format()	The format of the generated report (individual CSV files or zipped files of individual files).
String	formatAsString()	The format of the generated report (individual CSV files or zipped files of individual files).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
BusinessReportRecurrence	recurrence()	The recurrence of the reports.
String	s3BucketName()	The S3 bucket name of the output reports.
String	s3KeyPrefix()	The S3 key where the report is delivered.
String	scheduleName()	The name identifier of the schedule.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBusinessReportScheduleRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags for the business report schedule.
CreateBusinessReportScheduleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scheduleName

public final String scheduleName()

The name identifier of the schedule.

Returns:

The name identifier of the schedule.

s3BucketName

public final String s3BucketName()

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

Returns:

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

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:

BusinessReportFormat

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:

BusinessReportFormat

contentRange

public final BusinessReportContentRange contentRange()

The content range of the reports.

Returns:

The content range of the reports.

recurrence

public final BusinessReportRecurrence recurrence()

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

Returns:

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

clientRequestToken

public final String clientRequestToken()

The client request token.

Returns:

The client request token.

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()

The tags for the business report schedule.

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:

The tags for the business report schedule.

toBuilder

public CreateBusinessReportScheduleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBusinessReportScheduleRequest.Builder,CreateBusinessReportScheduleRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static CreateBusinessReportScheduleRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo