Class View

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

A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".

See Also:

  • Method Details

    • filters

      public final SearchFilter filters()

      An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.

      Returns:
      An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.

    • hasIncludedProperties

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

    • includedProperties

      public final List<IncludedProperty> includedProperties()

      A structure that contains additional information about the view.

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

      Returns:
      A structure that contains additional information about the view.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when this view was last modified.

      Returns:
      The date and time when this view was last modified.

    • owner

      public final String owner()

      The Amazon Web Services account that owns this view.

      Returns:
      The Amazon Web Services account that owns this view.

    • scope

      public final String scope()

      An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.

      If not specified, the value defaults to the Amazon Web Services account used to call this operation.

      Returns:
      An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.

      If not specified, the value defaults to the Amazon Web Services account used to call this operation.

    • viewArn

      public final String viewArn()

      The Amazon resource name (ARN) of the view.

      Returns:
      The Amazon resource name (ARN) of the view.

    • toBuilder

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

    • builder

      public static View.Builder builder()

    • serializableBuilderClass

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