java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorResponse
    - - software.amazon.awssdk.services.networkflowmonitor.model.GetScopeResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetScopeResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetScopeResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTargets()`	For responses, this returns true if the service returned a value for the Targets property.
`String`	`scopeArn()`	The Amazon Resource Name (ARN) of the scope.
`String`	`scopeId()`	The identifier for the scope that includes the resources you want to get data results for.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetScopeResponse.Builder>`	`serializableBuilderClass()`
`ScopeStatus`	`status()`	The status of a scope.
`String`	`statusAsString()`	The status of a scope.
`Map<String,String>`	`tags()`	The tags for a scope.
`List<TargetResource>`	`targets()`	The targets for a scope
`GetScopeResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - scopeId
```
public final String scopeId()
```
    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.
    
    Returns:
    
    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.
  - status
```
public final ScopeStatus status()
```
    The status of a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ScopeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.
    
    See Also:
    
    ScopeStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ScopeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.
    
    See Also:
    
    ScopeStatus
  - scopeArn
```
public final String scopeArn()
```
    The Amazon Resource Name (ARN) of the scope.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the scope.
  - hasTargets
```
public final boolean hasTargets()
```
    For responses, this returns true if the service returned a value for the Targets 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.
  - targets
```
public final List<TargetResource> targets()
```
    The targets for a scope
    
    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 hasTargets() method.
    
    Returns:
    
    The targets for a scope
  - 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()
```
    The tags for a scope.
    
    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:
    
    The tags for a scope.
  - toBuilder
```
public GetScopeResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetScopeResponse.Builder,GetScopeResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetScopeResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

scopeId

status

statusAsString

scopeArn

hasTargets

targets

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField