Class AccessGrant

java.lang.Object
software.amazon.awssdk.services.cloudwatchomni.model.AccessGrant
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AccessGrant.Builder,AccessGrant>
@Generated("software.amazon.awssdk:codegen") public final class AccessGrant extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AccessGrant.Builder,AccessGrant>

Full AccessGrant structure returned by API operations.

See Also:

  • Method Details

    • grantId

      public final String grantId()

      The unique ID of the access grant.

      Returns:
      The unique ID of the access grant.

    • grantArn

      public final String grantArn()

      The Amazon Resource Name (ARN) of the access grant.

      Returns:
      The Amazon Resource Name (ARN) of the access grant.

    • name

      public final String name()

      A name that identifies the access grant.

      Returns:
      A name that identifies the access grant.

    • accountId

      public final String accountId()

      The AWS account ID that owns the grant.

      Returns:
      The AWS account ID that owns the grant.

    • domainId

      public final String domainId()

      The ID of the domain the grant belongs to.

      Returns:
      The ID of the domain the grant belongs to.

    • principal

      public final AccessGrantPrincipal principal()

      The principal receiving the grant.

      Returns:
      The principal receiving the grant.

    • permission

      public final AccessGrantPermission permission()

      The permission granted.

      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 granted.
      See Also:

    • permissionAsString

      public final String permissionAsString()

      The permission granted.

      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 granted.
      See Also:

    • grantType

      public final AccessGrantType grantType()

      Who manages the grant.

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

      Returns:
      Who manages the grant.
      See Also:

    • grantTypeAsString

      public final String grantTypeAsString()

      Who manages the grant.

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

      Returns:
      Who manages the grant.
      See Also:

    • createdBy

      public final String createdBy()

      The principal that created the grant.

      Returns:
      The principal that created the grant.

    • createdAt

      public final Instant createdAt()

      The timestamp when the grant was created.

      Returns:
      The timestamp when the grant was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the grant was last updated.

      Returns:
      The timestamp when the grant was last updated.

    • spaceId

      public final String spaceId()

      The space this grant applies to. Domain-scoped grants are returned by ListDomainAccessGrantsForOrganization instead.

      Returns:
      The space this grant applies to. Domain-scoped grants are returned by ListDomainAccessGrantsForOrganization instead.

    • 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 allowed by the grant, 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 allowed by the grant, each with the resource scopes and conditions that limit those actions.

    • toBuilder

      public AccessGrant.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<AccessGrant.Builder,AccessGrant>
      Returns:
      a builder for type T

    • builder

      public static AccessGrant.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AccessGrant.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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