Class DescribeEffectivePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.organizations.model.OrganizationsRequest

software.amazon.awssdk.services.organizations.model.DescribeEffectivePolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEffectivePolicyRequest.Builder,DescribeEffectivePolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEffectivePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeEffectivePolicyRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final EffectivePolicyType	policyType()	The type of policy that you want information about.
final String	policyTypeAsString()	The type of policy that you want information about.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEffectivePolicyRequest.Builder>	serializableBuilderClass()
final String	targetId()	When you're signed in as the management account, specify the ID of the account that you want details about.
DescribeEffectivePolicyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

policyType

public final EffectivePolicyType policyType()

The type of policy that you want information about. You can specify one of the following values:

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

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

Returns:

The type of policy that you want information about. You can specify one of the following values:

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

See Also:

• EffectivePolicyType

policyTypeAsString

public final String policyTypeAsString()

The type of policy that you want information about. You can specify one of the following values:

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

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

Returns:

The type of policy that you want information about. You can specify one of the following values:

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

See Also:

• EffectivePolicyType

targetId

public final String targetId()

When you're signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

Returns:

When you're signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

toBuilder

public DescribeEffectivePolicyRequest.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<DescribeEffectivePolicyRequest.Builder,DescribeEffectivePolicyRequest>

Specified by:

toBuilder in class OrganizationsRequest

Returns:

a builder for type T

builder

public static DescribeEffectivePolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEffectivePolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.