Class CreateAccessGrantRequest

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

  • Method Details

    • domainId

      public final String domainId()

      The ID of the domain that contains the space.

      Returns:
      The ID of the domain that contains the space.

    • spaceId

      public final String spaceId()

      The ID of the space to scope the grant to.

      Returns:
      The ID of the space to scope the grant to.

    • name

      public final String name()

      A name that identifies the access grant.

      Returns:
      A name that identifies the access grant.

    • principal

      public final AccessGrantPrincipal principal()

      The principal receiving the grant.

      Returns:
      The principal receiving the grant.

    • permission

      public final AccessGrantPermission permission()

      The permission to grant. Exactly one permission is granted per request.

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

      Returns:
      The permission to grant. Exactly one permission is granted per request.
      See Also:

    • permissionAsString

      public final String permissionAsString()

      The permission to grant. Exactly one permission is granted per request.

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

      Returns:
      The permission to grant. Exactly one permission is granted per request.
      See Also:

    • hasScopedActions

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

    • scopedActions

      public final List<ScopedActions> scopedActions()

      Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

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

      Returns:
      Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

    • 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 Map<String,String> tags()

      The tags to associate with the access grant.

      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 to associate with the access grant.

    • clientToken

      public final String clientToken()

      Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

      Returns:
      Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

    • toBuilder

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

    • builder

      public static CreateAccessGrantRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.