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

Class Site

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.Site

All Implemented Interfaces:

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

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

Describes a site.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Site.Builder

Method Summary

Modifier and Type	Method	Description
static Site.Builder	builder()
Instant	createdAt()	The date and time that the site was created.
String	description()	The description of the site.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId()	The ID of the global network.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Location	location()	The location of the site.
List<SdkField<?>>	sdkFields()
static Class<? extends Site.Builder>	serializableBuilderClass()
String	siteArn()	The Amazon Resource Name (ARN) of the site.
String	siteId()	The ID of the site.
SiteState	state()	The state of the site.
String	stateAsString()	The state of the site.
List<Tag>	tags()	The tags for the site.
Site.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

siteId

public final String siteId()

The ID of the site.

Returns:

The ID of the site.

siteArn

public final String siteArn()

The Amazon Resource Name (ARN) of the site.

Returns:

The Amazon Resource Name (ARN) of the site.

globalNetworkId

public final String globalNetworkId()

The ID of the global network.

Returns:

The ID of the global network.

description

public final String description()

The description of the site.

Returns:

The description of the site.

location

public final Location location()

The location of the site.

Returns:

The location of the site.

createdAt

public final Instant createdAt()

The date and time that the site was created.

Returns:

The date and time that the site was created.

state

public final SiteState state()

The state of the site.

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

Returns:

The state of the site.

See Also:

SiteState

stateAsString

public final String stateAsString()

The state of the site.

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

Returns:

The state of the site.

See Also:

SiteState

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 for the site.

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 for the site.

toBuilder

public Site.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Site.Builder,Site>

builder

public static Site.Builder builder()

serializableBuilderClass

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