Package software.amazon.awssdk.services.controlcatalog.model

Class GetControlResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.controlcatalog.model.ControlCatalogResponse

software.amazon.awssdk.services.controlcatalog.model.GetControlResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetControlResponse.Builder,GetControlResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetControlResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the control.
ControlBehavior	behavior()	A term that identifies the control's functional behavior.
String	behaviorAsString()	A term that identifies the control's functional behavior.
static GetControlResponse.Builder	builder()
String	description()	A description of what the control does.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
ImplementationDetails	implementation()	Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.
String	name()	The display name of the control.
List<ControlParameter>	parameters()	Returns an array of ControlParameter objects that specify the parameters a control supports.
RegionConfiguration	regionConfiguration()	Returns the value of the RegionConfiguration property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetControlResponse.Builder>	serializableBuilderClass()
GetControlResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.controlcatalog.model.ControlCatalogResponse

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the control.

Returns:

The Amazon Resource Name (ARN) of the control.

name

public final String name()

The display name of the control.

Returns:

The display name of the control.

description

public final String description()

A description of what the control does.

Returns:

A description of what the control does.

behavior

public final ControlBehavior behavior()

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

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

Returns:

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

See Also:

ControlBehavior

behaviorAsString

public final String behaviorAsString()

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

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

Returns:

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

See Also:

ControlBehavior

regionConfiguration

public final RegionConfiguration regionConfiguration()

Returns the value of the RegionConfiguration property for this object.

Returns:

The value of the RegionConfiguration property for this object.

implementation

public final ImplementationDetails implementation()

Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.

Returns:

Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters 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.

parameters

public final List<ControlParameter> parameters()

Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

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

Returns:

Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

toBuilder

public GetControlResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetControlResponse.Builder,GetControlResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetControlResponse.Builder builder()

serializableBuilderClass

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