Package software.amazon.awssdk.services.networkmanager.model

Class NetworkResource

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.NetworkResource

All Implemented Interfaces:

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

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

Describes a network resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NetworkResource.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The Amazon Web Services account ID.
String	awsRegion()	The Amazon Web Services Region.
static NetworkResource.Builder	builder()
String	coreNetworkId()	The ID of a core network.
String	definition()	Information about the resource, in JSON format.
Instant	definitionTimestamp()	The time that the resource definition was retrieved.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata()	For responses, this returns true if the service returned a value for the Metadata property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,String>	metadata()	The resource metadata.
String	registeredGatewayArn()	The ARN of the gateway.
String	resourceArn()	The ARN of the resource.
String	resourceId()	The ID of the resource.
String	resourceType()	The resource type.
List<SdkField<?>>	sdkFields()
static Class<? extends NetworkResource.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags.
NetworkResource.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

registeredGatewayArn

public final String registeredGatewayArn()

The ARN of the gateway.

Returns:

The ARN of the gateway.

coreNetworkId

public final String coreNetworkId()

The ID of a core network.

Returns:

The ID of a core network.

awsRegion

public final String awsRegion()

The Amazon Web Services Region.

Returns:

The Amazon Web Services Region.

accountId

public final String accountId()

The Amazon Web Services account ID.

Returns:

The Amazon Web Services account ID.

resourceType

public final String resourceType()

The resource type.

The following are the supported resource types for Direct Connect:

• dxcon

• dx-gateway

• dx-vif

The following are the supported resource types for Network Manager:

• connection

• device

• link

• site

The following are the supported resource types for Amazon VPC:

• customer-gateway

• transit-gateway

• transit-gateway-attachment

• transit-gateway-connect-peer

• transit-gateway-route-table

• vpn-connection

Returns:

The resource type.

The following are the supported resource types for Direct Connect:

• dxcon

• dx-gateway

• dx-vif

The following are the supported resource types for Network Manager:

• connection

• device

• link

• site

The following are the supported resource types for Amazon VPC:

• customer-gateway

• transit-gateway

• transit-gateway-attachment

• transit-gateway-connect-peer

• transit-gateway-route-table

• vpn-connection

resourceId

public final String resourceId()

The ID of the resource.

Returns:

The ID of the resource.

resourceArn

public final String resourceArn()

The ARN of the resource.

Returns:

The ARN of the resource.

definition

public final String definition()

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

Returns:

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

definitionTimestamp

public final Instant definitionTimestamp()

The time that the resource definition was retrieved.

Returns:

The time that the resource definition was retrieved.

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 tags.

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.

hasMetadata

public final boolean hasMetadata()

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

metadata

public final Map<String,String> metadata()

The resource metadata.

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

Returns:

The resource metadata.

toBuilder

public NetworkResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NetworkResource.Builder,NetworkResource>

builder

public static NetworkResource.Builder builder()

serializableBuilderClass

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