Peering (AWS Java SDK :: Services :: NetworkManager 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.networkmanager.model.Peering

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Peering.Builder,Peering>

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

Describes a peering connection.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Peering.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Peering.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Peering.Builder`	`builder()`
`String`	`coreNetworkArn()` The ARN of a core network.
`String`	`coreNetworkId()` The ID of the core network for the peering request.
`Instant`	`createdAt()` The timestamp when the attachment peer was created.
`String`	`edgeLocation()` The edge location for the peer.
`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.
`String`	`ownerAccountId()` The ID of the account owner.
`String`	`peeringId()` The ID of the peering attachment.
`PeeringType`	`peeringType()` The type of peering.
`String`	`peeringTypeAsString()` The type of peering.
`String`	`resourceArn()` The resource ARN of the peer.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Peering.Builder>`	`serializableBuilderClass()`
`PeeringState`	`state()` The current state of the peering connection.
`String`	`stateAsString()` The current state of the peering connection.
`List<Tag>`	`tags()` The list of key-value tags associated with the peering.
`Peering.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 the core network for the peering request.
    
    Returns:
    
    The ID of the core network for the peering request.
  - coreNetworkArn
```
public final String coreNetworkArn()
```
    The ARN of a core network.
    
    Returns:
    
    The ARN of a core network.
  - peeringId
```
public final String peeringId()
```
    The ID of the peering attachment.
    
    Returns:
    
    The ID of the peering attachment.
  - ownerAccountId
```
public final String ownerAccountId()
```
    The ID of the account owner.
    
    Returns:
    
    The ID of the account owner.
  - peeringType
```
public final PeeringType peeringType()
```
    The type of peering. This will be TRANSIT_GATEWAY.
    
    If the service returns an enum value that is not available in the current SDK version, peeringType will return PeeringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peeringTypeAsString().
    
    Returns:
    
    The type of peering. This will be TRANSIT_GATEWAY.
    
    See Also:
    
    PeeringType
  - peeringTypeAsString
```
public final String peeringTypeAsString()
```
    The type of peering. This will be TRANSIT_GATEWAY.
    
    If the service returns an enum value that is not available in the current SDK version, peeringType will return PeeringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peeringTypeAsString().
    
    Returns:
    
    The type of peering. This will be TRANSIT_GATEWAY.
    
    See Also:
    
    PeeringType
  - state
```
public final PeeringState state()
```
    The current state of the peering connection.
    
    If the service returns an enum value that is not available in the current SDK version, state will return PeeringState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the peering connection.
    
    See Also:
    
    PeeringState
  - stateAsString
```
public final String stateAsString()
```
    The current state of the peering connection.
    
    If the service returns an enum value that is not available in the current SDK version, state will return PeeringState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the peering connection.
    
    See Also:
    
    PeeringState
  - edgeLocation
```
public final String edgeLocation()
```
    The edge location for the peer.
    
    Returns:
    
    The edge location for the peer.
  - resourceArn
```
public final String resourceArn()
```
    The resource ARN of the peer.
    
    Returns:
    
    The resource ARN of the peer.
  - 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 List<Tag> tags()
```
    The list of key-value tags associated with the peering.
    
    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 list of key-value tags associated with the peering.
  - createdAt
```
public final Instant createdAt()
```
    The timestamp when the attachment peer was created.
    
    Returns:
    
    The timestamp when the attachment peer was created.
  - toBuilder
```
public Peering.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Peering.Builder,Peering>
  - builder
```
public static Peering.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Peering.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

Class Peering

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

coreNetworkId

coreNetworkArn

peeringId

ownerAccountId

peeringType

peeringTypeAsString

state

stateAsString

edgeLocation

resourceArn

hasTags

tags

createdAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields