Class GetScopeResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScopeResponse.Builder,GetScopeResponse>

@Generated("software.amazon.awssdk:codegen") public final class GetScopeResponse extends NetworkSecurityManagerResponse implements ToCopyableBuilder<GetScopeResponse.Builder,GetScopeResponse>
  • Method Details

    • scopeId

      public final String scopeId()

      The service-generated id of the scope.

      Returns:
      The service-generated id of the scope.
    • scopeArn

      public final String scopeArn()

      The Amazon Resource Name (ARN) of the scope.

      Returns:
      The Amazon Resource Name (ARN) of the scope.
    • scopeName

      public final String scopeName()

      The name of the scope.

      Returns:
      The name of the scope.
    • scopeDescription

      public final String scopeDescription()

      A description of the scope.

      Returns:
      A description of the scope.
    • scopeConfiguration

      public final ScopeConfiguration scopeConfiguration()

      The configuration that defines which accounts and resources are in scope.

      Returns:
      The configuration that defines which accounts and resources are in scope.
    • specializedScopeType

      public final SpecializedScopeType specializedScopeType()

      The specialized type of the scope, if the scope is built for one specific purpose. A scope with no specializedScopeType is a standard scope that you can associate with a deployment. A specialized scope can be used only for the purpose that its type defines and can't be associated with a deployment. This value is set when the scope is created and can't be changed.

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

      Returns:
      The specialized type of the scope, if the scope is built for one specific purpose. A scope with no specializedScopeType is a standard scope that you can associate with a deployment. A specialized scope can be used only for the purpose that its type defines and can't be associated with a deployment. This value is set when the scope is created and can't be changed.
      See Also:
    • specializedScopeTypeAsString

      public final String specializedScopeTypeAsString()

      The specialized type of the scope, if the scope is built for one specific purpose. A scope with no specializedScopeType is a standard scope that you can associate with a deployment. A specialized scope can be used only for the purpose that its type defines and can't be associated with a deployment. This value is set when the scope is created and can't be changed.

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

      Returns:
      The specialized type of the scope, if the scope is built for one specific purpose. A scope with no specializedScopeType is a standard scope that you can associate with a deployment. A specialized scope can be used only for the purpose that its type defines and can't be associated with a deployment. This value is set when the scope is created and can't be changed.
      See Also:
    • status

      public final EntityStatus status()

      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
      See Also:
    • statusAsString

      public final String statusAsString()

      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
      See Also:
    • version

      public final String version()

      The version of the resource.

      Returns:
      The version of the resource.
    • updateToken

      public final String updateToken()

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

      Returns:
      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
    • isSnapshot

      public final Boolean isSnapshot()

      Specifies whether the resource is a snapshot of a published version.

      Returns:
      Specifies whether the resource is a snapshot of a published version.
    • hasPublishedVersion

      public final Boolean hasPublishedVersion()

      Specifies whether a published version of the resource exists.

      Returns:
      Specifies whether a published version of the resource exists.
    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated.

      Returns:
      The time when the resource was last updated.
    • toBuilder

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

      public static GetScopeResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends GetScopeResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.