Class ResourceScope

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

A single resource scope entry within an AccessGrant. Associates a resource type with optional ARN patterns, tag conditions, and row-level filters.

See Also:

  • Method Details

    • resourceType

      public final String resourceType()

      Resource type name (e.g., "DataSet", "OmniDashboard").

      Returns:
      Resource type name (e.g., "DataSet", "OmniDashboard").

    • hasResourceArns

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

    • resourceArns

      public final List<String> resourceArns()

      Specific resource ARNs or ARN patterns. When set, actions are limited to these resources. When absent, defaults to "*".

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

      Returns:
      Specific resource ARNs or ARN patterns. When set, actions are limited to these resources. When absent, defaults to "*".

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

      Tag-based conditions for dynamic resource scoping. Access applies only to resources carrying all of the specified tag key/value pairs.

      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:
      Tag-based conditions for dynamic resource scoping. Access applies only to resources carrying all of the specified tag key/value pairs.

    • signalTypes

      public final List<SignalType> signalTypes()

      Signal types this scope's row filtering applies to. Required when rowScopeGroups is set.

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

      Returns:
      Signal types this scope's row filtering applies to. Required when rowScopeGroups is set.

    • hasSignalTypes

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

    • signalTypesAsStrings

      public final List<String> signalTypesAsStrings()

      Signal types this scope's row filtering applies to. Required when rowScopeGroups is set.

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

      Returns:
      Signal types this scope's row filtering applies to. Required when rowScopeGroups is set.

    • hasRowScopeGroups

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

    • rowScopeGroups

      public final List<List<RowScope>> rowScopeGroups()

      Row-level filters for this scope, as an OR of AND-groups: a row is visible when it matches every filter in any one group. Requires signalTypes.

      Row filters are additive across a principal's matching grants. A signal type with no matching group is unrestricted, and when rowScopeGroups is omitted all rows are visible for all signal types.

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

      Returns:
      Row-level filters for this scope, as an OR of AND-groups: a row is visible when it matches every filter in any one group. Requires signalTypes.

      Row filters are additive across a principal's matching grants. A signal type with no matching group is unrestricted, and when rowScopeGroups is omitted all rows are visible for all signal types.

    • toBuilder

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

    • builder

      public static ResourceScope.Builder builder()

    • serializableBuilderClass

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