Package software.amazon.awssdk.services.outposts.model

Class Site

java.lang.Object

software.amazon.awssdk.services.outposts.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>

Information about 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
String	accountId()	Returns the value of the AccountId property for this object.
static Site.Builder	builder()
String	description()	Returns the value of the Description property for this object.
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	name()	Returns the value of the Name property for this object.
String	notes()	Notes about a site.
String	operatingAddressCity()	City where the hardware is installed and powered on.
String	operatingAddressCountryCode()	The ISO-3166 two-letter country code where the hardware is installed and powered on.
String	operatingAddressStateOrRegion()	State or region where the hardware is installed and powered on.
RackPhysicalProperties	rackPhysicalProperties()	Information about the physical and logistical details for a rack at the site.
List<SdkField<?>>	sdkFields()
static Class<? extends Site.Builder>	serializableBuilderClass()
String	siteArn()	Returns the value of the SiteArn property for this object.
String	siteId()	Returns the value of the SiteId property for this object.
Map<String,String>	tags()	The site tags.
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()

Returns the value of the SiteId property for this object.

Returns:

The value of the SiteId property for this object.

accountId

public final String accountId()

Returns the value of the AccountId property for this object.

Returns:

The value of the AccountId property for this object.

name

public final String name()

Returns the value of the Name property for this object.

Returns:

The value of the Name property for this object.

description

public final String description()

Returns the value of the Description property for this object.

Returns:

The value of the Description property for this object.

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 Map<String,String> tags()

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

siteArn

public final String siteArn()

Returns the value of the SiteArn property for this object.

Returns:

The value of the SiteArn property for this object.

notes

public final String notes()

Notes about a site.

Returns:

Notes about a site.

operatingAddressCountryCode

public final String operatingAddressCountryCode()

The ISO-3166 two-letter country code where the hardware is installed and powered on.

Returns:

The ISO-3166 two-letter country code where the hardware is installed and powered on.

operatingAddressStateOrRegion

public final String operatingAddressStateOrRegion()

State or region where the hardware is installed and powered on.

Returns:

State or region where the hardware is installed and powered on.

operatingAddressCity

public final String operatingAddressCity()

City where the hardware is installed and powered on.

Returns:

City where the hardware is installed and powered on.

rackPhysicalProperties

public final RackPhysicalProperties rackPhysicalProperties()

Information about the physical and logistical details for a rack at the site.

Returns:

Information about the physical and logistical details for a rack at 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