Class AzureScope

java.lang.Object
software.amazon.awssdk.services.observabilityadmin.model.AzureScope
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AzureScope.Builder,AzureScope>

@Generated("software.amazon.awssdk:codegen") public final class AzureScope extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AzureScope.Builder,AzureScope>

The Azure resources to collect telemetry from. These are the resources found by Subscriptions, Regions, and ResourceTypes, optionally narrowed by TagFilters, plus any resources listed in Resources. You can specify:

  • Subscriptions, Regions, and ResourceTypes together

  • Resources

  • Both

See Also:
  • Method Details

    • subscriptions

      public final AzureSubscriptionScope subscriptions()

      The subscriptions to find resources in: all subscriptions that the connector can read, or a list of subscriptions. Required when you use Regions and ResourceTypes.

      Returns:
      The subscriptions to find resources in: all subscriptions that the connector can read, or a list of subscriptions. Required when you use Regions and ResourceTypes.
    • hasRegions

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

      public final List<String> regions()

      The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes.

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

      Returns:
      The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes.
    • hasResourceTypes

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

      public final List<String> resourceTypes()

      The Azure resource types to find. Required when you use Subscriptions and Regions.

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

      Returns:
      The Azure resource types to find. Required when you use Subscriptions and Regions.
    • hasTagFilters

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

      public final List<TagFilter> tagFilters()

      Limits the resources found by Subscriptions, Regions, and ResourceTypes to those that have these tags. You can specify up to 50 filters.

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

      Returns:
      Limits the resources found by Subscriptions, Regions, and ResourceTypes to those that have these tags. You can specify up to 50 filters.
    • hasResources

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

      public final List<AzureResourceIdScope> resources()

      Specific Azure resources, listed by Azure Region.

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

      Returns:
      Specific Azure resources, listed by Azure Region.
    • toBuilder

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

      public static AzureScope.Builder builder()
    • serializableBuilderClass

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