Package software.amazon.awssdk.services.ecs.model

Class ListAccountSettingsRequest

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

  • Method Details

    • name

      public final SettingName name()

      The name of the account setting you want to list the settings for.

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

      Returns:
      The name of the account setting you want to list the settings for.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the account setting you want to list the settings for.

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

      Returns:
      The name of the account setting you want to list the settings for.
      See Also:

    • value

      public final String value()

      The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

      Returns:
      The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

    • principalArn

      public final String principalArn()

      The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

      In order to use this parameter, you must be the root user, or the principal.

      Federated users assume the account setting of the root user and can't have explicit account settings set for them.

      Returns:
      The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

      In order to use this parameter, you must be the root user, or the principal.

      Federated users assume the account setting of the root user and can't have explicit account settings set for them.

    • effectiveSettings

      public final Boolean effectiveSettings()

      Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

      Returns:
      Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

      Returns:
      The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    • maxResults

      public final Integer maxResults()

      The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

      Returns:
      The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

    • toBuilder

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

    • builder

      public static ListAccountSettingsRequest.Builder builder()

    • serializableBuilderClass

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