software.amazon.awssdk.services.networkmanager.model

Class CoreNetworkPolicy

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.CoreNetworkPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CoreNetworkPolicy.Builder,CoreNetworkPolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class CoreNetworkPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CoreNetworkPolicy.Builder,CoreNetworkPolicy>

Describes a core network policy. You can have only one LIVE Core Policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CoreNetworkPolicy.Builder

Method Summary

Modifier and Type	Method and Description
CoreNetworkPolicyAlias	alias() Whether a core network policy is the current LIVE policy or the most recently submitted policy.
String	aliasAsString() Whether a core network policy is the current LIVE policy or the most recently submitted policy.
static CoreNetworkPolicy.Builder	builder()
ChangeSetState	changeSetState() The state of a core network policy.
String	changeSetStateAsString() The state of a core network policy.
String	coreNetworkId() The ID of a core network.
Instant	createdAt() The timestamp when a core network policy was created.
String	description() The description of a core network policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyErrors() For responses, this returns true if the service returned a value for the PolicyErrors property.
String	policyDocument() Describes a core network policy.
List<CoreNetworkPolicyError>	policyErrors() Describes any errors in a core network policy.
Integer	policyVersionId() The ID of the policy version.
List<SdkField<?>>	sdkFields()
static Class<? extends CoreNetworkPolicy.Builder>	serializableBuilderClass()
CoreNetworkPolicy.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

coreNetworkId

public final String coreNetworkId()

The ID of a core network.

Returns:

The ID of a core network.

policyVersionId

public final Integer policyVersionId()

The ID of the policy version.

Returns:

The ID of the policy version.

alias

public final CoreNetworkPolicyAlias alias()

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

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

Returns:

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

See Also:

CoreNetworkPolicyAlias

aliasAsString

public final String aliasAsString()

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

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

Returns:

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

See Also:

CoreNetworkPolicyAlias

description

public final String description()

The description of a core network policy.

Returns:

The description of a core network policy.

createdAt

public final Instant createdAt()

The timestamp when a core network policy was created.

Returns:

The timestamp when a core network policy was created.

changeSetState

public final ChangeSetState changeSetState()

The state of a core network policy.

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

Returns:

The state of a core network policy.

See Also:

ChangeSetState

changeSetStateAsString

public final String changeSetStateAsString()

The state of a core network policy.

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

Returns:

The state of a core network policy.

See Also:

ChangeSetState

hasPolicyErrors

public final boolean hasPolicyErrors()

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

policyErrors

public final List<CoreNetworkPolicyError> policyErrors()

Describes any errors in a core network policy.

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

Returns:

Describes any errors in a core network policy.

policyDocument

public final String policyDocument()

Describes a core network policy.

Returns:

Describes a core network policy.

toBuilder

public CoreNetworkPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CoreNetworkPolicy.Builder,CoreNetworkPolicy>

builder

public static CoreNetworkPolicy.Builder builder()

serializableBuilderClass

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

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo