Package software.amazon.awssdk.services.workspaces.model

Class RelatedWorkspaceProperties

java.lang.Object

software.amazon.awssdk.services.workspaces.model.RelatedWorkspaceProperties

All Implemented Interfaces:

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

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

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RelatedWorkspaceProperties.Builder

Method Summary

Modifier and Type	Method	Description
static RelatedWorkspaceProperties.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	region()	The Region of the related WorkSpace.
final List<SdkField<?>>	sdkFields()
static Class<? extends RelatedWorkspaceProperties.Builder>	serializableBuilderClass()
final WorkspaceState	state()	Indicates the state of the WorkSpace.
final String	stateAsString()	Indicates the state of the WorkSpace.
RelatedWorkspaceProperties.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final StandbyWorkspaceRelationshipType	type()	Indicates the type of WorkSpace.
final String	typeAsString()	Indicates the type of WorkSpace.
final String	workspaceId()	The identifier of the related WorkSpace.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

workspaceId

public final String workspaceId()

The identifier of the related WorkSpace.

Returns:

The identifier of the related WorkSpace.

region

public final String region()

The Region of the related WorkSpace.

Returns:

The Region of the related WorkSpace.

state

public final WorkspaceState state()

Indicates the state of the WorkSpace.

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

Returns:

Indicates the state of the WorkSpace.

See Also:

• WorkspaceState

stateAsString

public final String stateAsString()

Indicates the state of the WorkSpace.

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

Returns:

Indicates the state of the WorkSpace.

See Also:

• WorkspaceState

type

public final StandbyWorkspaceRelationshipType type()

Indicates the type of WorkSpace.

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

Returns:

Indicates the type of WorkSpace.

See Also:

• StandbyWorkspaceRelationshipType

typeAsString

public final String typeAsString()

Indicates the type of WorkSpace.

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

Returns:

Indicates the type of WorkSpace.

See Also:

• StandbyWorkspaceRelationshipType

toBuilder

public RelatedWorkspaceProperties.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RelatedWorkspaceProperties.Builder,RelatedWorkspaceProperties>

Returns:

a builder for type T

builder

public static RelatedWorkspaceProperties.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.