Package software.amazon.awssdk.services.iottwinmaker.model

Class ListSyncResourcesRequest

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

  • Method Details

    • workspaceId

      public final String workspaceId()

      The ID of the workspace that contains the sync job.

      Returns:
      The ID of the workspace that contains the sync job.

    • syncSource

      public final String syncSource()

      The sync source.

      Currently the only supported syncSource is SITEWISE .

      Returns:
      The sync source.

      Currently the only supported syncSource is SITEWISE .

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters 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.

    • filters

      public final List<SyncResourceFilter> filters()

      A list of objects that filter the request.

      The following filter combinations are supported:

      • Filter with state

      • Filter with ResourceType and ResourceId

      • Filter with ResourceType and ExternalId

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

      Returns:
      A list of objects that filter the request.

      The following filter combinations are supported:

      • Filter with state

      • Filter with ResourceType and ResourceId

      • Filter with ResourceType and ExternalId

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return at one time. The default is 50.

      Valid Range: Minimum value of 0. Maximum value of 200.

      Returns:
      The maximum number of results to return at one time. The default is 50.

      Valid Range: Minimum value of 0. Maximum value of 200.

    • nextToken

      public final String nextToken()

      The string that specifies the next page of results.

      Returns:
      The string that specifies the next page of results.

    • toBuilder

      public ListSyncResourcesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListSyncResourcesRequest.Builder,ListSyncResourcesRequest>
      Specified by:
      toBuilder in class IoTTwinMakerRequest

    • builder

      public static ListSyncResourcesRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo