software.amazon.awssdk.services.ssmcontacts.model

Class ListPreviewRotationShiftsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmcontacts.model.SsmContactsRequest

software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPreviewRotationShiftsRequest.Builder,ListPreviewRotationShiftsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListPreviewRotationShiftsRequest
extends SsmContactsRequest
implements ToCopyableBuilder<ListPreviewRotationShiftsRequest.Builder,ListPreviewRotationShiftsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListPreviewRotationShiftsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListPreviewRotationShiftsRequest.Builder	builder()
Instant	endTime() The date and time a rotation shift would end.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMembers() For responses, this returns true if the service returned a value for the Members property.
boolean	hasOverrides() For responses, this returns true if the service returned a value for the Overrides property.
Integer	maxResults() The maximum number of items to return for this call.
List<String>	members() The contacts that would be assigned to a rotation.
String	nextToken() A token to start the list.
List<PreviewOverride>	overrides() Information about changes that would be made in a rotation override.
RecurrenceSettings	recurrence() Information about how long a rotation would last before restarting at the beginning of the shift order.
Instant	rotationStartTime() The date and time a rotation would begin.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPreviewRotationShiftsRequest.Builder>	serializableBuilderClass()
Instant	startTime() Used to filter the range of calculated shifts before sending the response back to the user.
String	timeZoneId() The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format.
ListPreviewRotationShiftsRequest.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

rotationStartTime

public final Instant rotationStartTime()

The date and time a rotation would begin. The first shift is calculated from this date and time.

Returns:

The date and time a rotation would begin. The first shift is calculated from this date and time.

startTime

public final Instant startTime()

Used to filter the range of calculated shifts before sending the response back to the user.

Returns:

Used to filter the range of calculated shifts before sending the response back to the user.

endTime

public final Instant endTime()

The date and time a rotation shift would end.

Returns:

The date and time a rotation shift would end.

hasMembers

public final boolean hasMembers()

For responses, this returns true if the service returned a value for the Members 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.

members

public final List<String> members()

The contacts that would be assigned to a rotation.

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 hasMembers() method.

Returns:

The contacts that would be assigned to a rotation.

timeZoneId

public final String timeZoneId()

The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".

Returns:

The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".

recurrence

public final RecurrenceSettings recurrence()

Information about how long a rotation would last before restarting at the beginning of the shift order.

Returns:

Information about how long a rotation would last before restarting at the beginning of the shift order.

hasOverrides

public final boolean hasOverrides()

For responses, this returns true if the service returned a value for the Overrides 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.

overrides

public final List<PreviewOverride> overrides()

Information about changes that would be made in a rotation override.

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 hasOverrides() method.

Returns:

Information about changes that would be made in a rotation override.

nextToken

public final String nextToken()

A token to start the list. This token is used to get the next set of results.

Returns:

A token to start the list. This token is used to get the next set of results.

maxResults

public final Integer maxResults()

The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.

Returns:

The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.

toBuilder

public ListPreviewRotationShiftsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPreviewRotationShiftsRequest.Builder,ListPreviewRotationShiftsRequest>

Specified by:

toBuilder in class SsmContactsRequest

builder

public static ListPreviewRotationShiftsRequest.Builder builder()

serializableBuilderClass

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