NetworkResource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkmanager.model.NetworkResource

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NetworkResource
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a network resource.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NetworkResource()

Constructors
Constructor and Description
`NetworkResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkResource`	`addMetadataEntry(String key, String value)` Add a single Metadata entry
`NetworkResource`	`clearMetadataEntries()` Removes all the entries added into Metadata.
`NetworkResource`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The Amazon Web Services account ID.
`String`	`getAwsRegion()` The Amazon Web Services Region.
`String`	`getCoreNetworkId()` a core network ID.
`String`	`getDefinition()` Information about the resource, in JSON format.
`Date`	`getDefinitionTimestamp()` The time that the resource definition was retrieved.
`Map<String,String>`	`getMetadata()` The resource metadata.
`String`	`getRegisteredGatewayArn()` The ARN of the gateway.
`String`	`getResourceArn()` The ARN of the resource.
`String`	`getResourceId()` The ID of the resource.
`String`	`getResourceType()` The resource type.
`List<Tag>`	`getTags()` The tags.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The Amazon Web Services account ID.
`void`	`setAwsRegion(String awsRegion)` The Amazon Web Services Region.
`void`	`setCoreNetworkId(String coreNetworkId)` a core network ID.
`void`	`setDefinition(String definition)` Information about the resource, in JSON format.
`void`	`setDefinitionTimestamp(Date definitionTimestamp)` The time that the resource definition was retrieved.
`void`	`setMetadata(Map<String,String> metadata)` The resource metadata.
`void`	`setRegisteredGatewayArn(String registeredGatewayArn)` The ARN of the gateway.
`void`	`setResourceArn(String resourceArn)` The ARN of the resource.
`void`	`setResourceId(String resourceId)` The ID of the resource.
`void`	`setResourceType(String resourceType)` The resource type.
`void`	`setTags(Collection<Tag> tags)` The tags.
`String`	`toString()` Returns a string representation of this object.
`NetworkResource`	`withAccountId(String accountId)` The Amazon Web Services account ID.
`NetworkResource`	`withAwsRegion(String awsRegion)` The Amazon Web Services Region.
`NetworkResource`	`withCoreNetworkId(String coreNetworkId)` a core network ID.
`NetworkResource`	`withDefinition(String definition)` Information about the resource, in JSON format.
`NetworkResource`	`withDefinitionTimestamp(Date definitionTimestamp)` The time that the resource definition was retrieved.
`NetworkResource`	`withMetadata(Map<String,String> metadata)` The resource metadata.
`NetworkResource`	`withRegisteredGatewayArn(String registeredGatewayArn)` The ARN of the gateway.
`NetworkResource`	`withResourceArn(String resourceArn)` The ARN of the resource.
`NetworkResource`	`withResourceId(String resourceId)` The ID of the resource.
`NetworkResource`	`withResourceType(String resourceType)` The resource type.
`NetworkResource`	`withTags(Collection<Tag> tags)` The tags.
`NetworkResource`	`withTags(Tag... tags)` The tags.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NetworkResource
```
public NetworkResource()
```
- Method Detail
  - setRegisteredGatewayArn
```
public void setRegisteredGatewayArn(String registeredGatewayArn)
```
    The ARN of the gateway.
    
    Parameters:
    
    registeredGatewayArn - The ARN of the gateway.
  - getRegisteredGatewayArn
```
public String getRegisteredGatewayArn()
```
    The ARN of the gateway.
    
    Returns:
    
    The ARN of the gateway.
  - withRegisteredGatewayArn
```
public NetworkResource withRegisteredGatewayArn(String registeredGatewayArn)
```
    The ARN of the gateway.
    
    Parameters:
    
    registeredGatewayArn - The ARN of the gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCoreNetworkId
```
public void setCoreNetworkId(String coreNetworkId)
```
    a core network ID.
    
    Parameters:
    
    coreNetworkId - a core network ID.
  - getCoreNetworkId
```
public String getCoreNetworkId()
```
    a core network ID.
    
    Returns:
    
    a core network ID.
  - withCoreNetworkId
```
public NetworkResource withCoreNetworkId(String coreNetworkId)
```
    a core network ID.
    
    Parameters:
    
    coreNetworkId - a core network ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAwsRegion
```
public void setAwsRegion(String awsRegion)
```
    The Amazon Web Services Region.
    
    Parameters:
    
    awsRegion - The Amazon Web Services Region.
  - getAwsRegion
```
public String getAwsRegion()
```
    The Amazon Web Services Region.
    
    Returns:
    
    The Amazon Web Services Region.
  - withAwsRegion
```
public NetworkResource withAwsRegion(String awsRegion)
```
    The Amazon Web Services Region.
    
    Parameters:
    
    awsRegion - The Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The Amazon Web Services account ID.
    
    Parameters:
    
    accountId - The Amazon Web Services account ID.
  - getAccountId
```
public String getAccountId()
```
    The Amazon Web Services account ID.
    
    Returns:
    
    The Amazon Web Services account ID.
  - withAccountId
```
public NetworkResource withAccountId(String accountId)
```
    The Amazon Web Services account ID.
    
    Parameters:
    
    accountId - The Amazon Web Services account ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(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
    Parameters:
    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
  - getResourceType
```
public String getResourceType()
```
    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
  - withResourceType
```
public NetworkResource withResourceType(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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceId
```
public void setResourceId(String resourceId)
```
    The ID of the resource.
    
    Parameters:
    
    resourceId - The ID of the resource.
  - getResourceId
```
public String getResourceId()
```
    The ID of the resource.
    
    Returns:
    
    The ID of the resource.
  - withResourceId
```
public NetworkResource withResourceId(String resourceId)
```
    The ID of the resource.
    
    Parameters:
    
    resourceId - The ID of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    The ARN of the resource.
    
    Parameters:
    
    resourceArn - The ARN of the resource.
  - getResourceArn
```
public String getResourceArn()
```
    The ARN of the resource.
    
    Returns:
    
    The ARN of the resource.
  - withResourceArn
```
public NetworkResource withResourceArn(String resourceArn)
```
    The ARN of the resource.
    
    Parameters:
    
    resourceArn - The ARN of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(String definition)
```
    Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
    
    Parameters:
    
    definition - Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
  - getDefinition
```
public String getDefinition()
```
    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.
  - withDefinition
```
public NetworkResource withDefinition(String definition)
```
    Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
    
    Parameters:
    
    definition - Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinitionTimestamp
```
public void setDefinitionTimestamp(Date definitionTimestamp)
```
    The time that the resource definition was retrieved.
    
    Parameters:
    
    definitionTimestamp - The time that the resource definition was retrieved.
  - getDefinitionTimestamp
```
public Date getDefinitionTimestamp()
```
    The time that the resource definition was retrieved.
    
    Returns:
    
    The time that the resource definition was retrieved.
  - withDefinitionTimestamp
```
public NetworkResource withDefinitionTimestamp(Date definitionTimestamp)
```
    The time that the resource definition was retrieved.
    
    Parameters:
    
    definitionTimestamp - The time that the resource definition was retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags.
    
    Returns:
    
    The tags.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags.
    
    Parameters:
    
    tags - The tags.
  - withTags
```
public NetworkResource withTags(Tag... tags)
```
    The tags.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public NetworkResource withTags(Collection<Tag> tags)
```
    The tags.
    
    Parameters:
    
    tags - The tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetadata
```
public Map<String,String> getMetadata()
```
    The resource metadata.
    
    Returns:
    
    The resource metadata.
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
    The resource metadata.
    
    Parameters:
    
    metadata - The resource metadata.
  - withMetadata
```
public NetworkResource withMetadata(Map<String,String> metadata)
```
    The resource metadata.
    
    Parameters:
    
    metadata - The resource metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetadataEntry
```
public NetworkResource addMetadataEntry(String key,
                                        String value)
```
    Add a single Metadata entry
    
    See Also:
    
    withMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearMetadataEntries
```
public NetworkResource clearMetadataEntries()
```
    Removes all the entries added into Metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NetworkResource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class NetworkResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetworkResource

Method Detail

setRegisteredGatewayArn

getRegisteredGatewayArn

withRegisteredGatewayArn

setCoreNetworkId

getCoreNetworkId

withCoreNetworkId

setAwsRegion

getAwsRegion

withAwsRegion

setAccountId

getAccountId

withAccountId

setResourceType

getResourceType

withResourceType

setResourceId

getResourceId

withResourceId

setResourceArn

getResourceArn

withResourceArn

setDefinition

getDefinition

withDefinition

setDefinitionTimestamp

getDefinitionTimestamp

withDefinitionTimestamp

getTags

setTags

withTags

withTags

getMetadata

setMetadata

withMetadata

addMetadataEntry

clearMetadataEntries

toString

equals

hashCode

clone

marshall