EnvironmentSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspacesthinclient.model.EnvironmentSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes an environment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnvironmentSummary()

Constructors
Constructor and Description
`EnvironmentSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnvironmentSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActivationCode()` The activation code to register a device to the environment.
`String`	`getArn()` The Amazon Resource Name (ARN) of the environment.
`Date`	`getCreatedAt()` The timestamp of when the environment was created.
`String`	`getDesiredSoftwareSetId()` The ID of the software set to apply.
`String`	`getDesktopArn()` The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
`String`	`getDesktopEndpoint()` The URL for the identity provider login (only for environments that use AppStream 2.0).
`String`	`getDesktopType()` The type of streaming desktop for the environment.
`String`	`getId()` The ID of the environment.
`MaintenanceWindow`	`getMaintenanceWindow()` A specification for a time window to apply software updates.
`String`	`getName()` The name of the environment.
`String`	`getPendingSoftwareSetId()` The ID of the software set that is pending to be installed.
`String`	`getSoftwareSetUpdateMode()` An option to define which software updates to apply.
`String`	`getSoftwareSetUpdateSchedule()` An option to define if software updates should be applied within a maintenance window.
`Date`	`getUpdatedAt()` The timestamp of when the device was updated.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActivationCode(String activationCode)` The activation code to register a device to the environment.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the environment.
`void`	`setCreatedAt(Date createdAt)` The timestamp of when the environment was created.
`void`	`setDesiredSoftwareSetId(String desiredSoftwareSetId)` The ID of the software set to apply.
`void`	`setDesktopArn(String desktopArn)` The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
`void`	`setDesktopEndpoint(String desktopEndpoint)` The URL for the identity provider login (only for environments that use AppStream 2.0).
`void`	`setDesktopType(String desktopType)` The type of streaming desktop for the environment.
`void`	`setId(String id)` The ID of the environment.
`void`	`setMaintenanceWindow(MaintenanceWindow maintenanceWindow)` A specification for a time window to apply software updates.
`void`	`setName(String name)` The name of the environment.
`void`	`setPendingSoftwareSetId(String pendingSoftwareSetId)` The ID of the software set that is pending to be installed.
`void`	`setSoftwareSetUpdateMode(String softwareSetUpdateMode)` An option to define which software updates to apply.
`void`	`setSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)` An option to define if software updates should be applied within a maintenance window.
`void`	`setUpdatedAt(Date updatedAt)` The timestamp of when the device was updated.
`String`	`toString()` Returns a string representation of this object.
`EnvironmentSummary`	`withActivationCode(String activationCode)` The activation code to register a device to the environment.
`EnvironmentSummary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the environment.
`EnvironmentSummary`	`withCreatedAt(Date createdAt)` The timestamp of when the environment was created.
`EnvironmentSummary`	`withDesiredSoftwareSetId(String desiredSoftwareSetId)` The ID of the software set to apply.
`EnvironmentSummary`	`withDesktopArn(String desktopArn)` The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
`EnvironmentSummary`	`withDesktopEndpoint(String desktopEndpoint)` The URL for the identity provider login (only for environments that use AppStream 2.0).
`EnvironmentSummary`	`withDesktopType(DesktopType desktopType)` The type of streaming desktop for the environment.
`EnvironmentSummary`	`withDesktopType(String desktopType)` The type of streaming desktop for the environment.
`EnvironmentSummary`	`withId(String id)` The ID of the environment.
`EnvironmentSummary`	`withMaintenanceWindow(MaintenanceWindow maintenanceWindow)` A specification for a time window to apply software updates.
`EnvironmentSummary`	`withName(String name)` The name of the environment.
`EnvironmentSummary`	`withPendingSoftwareSetId(String pendingSoftwareSetId)` The ID of the software set that is pending to be installed.
`EnvironmentSummary`	`withSoftwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)` An option to define which software updates to apply.
`EnvironmentSummary`	`withSoftwareSetUpdateMode(String softwareSetUpdateMode)` An option to define which software updates to apply.
`EnvironmentSummary`	`withSoftwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)` An option to define if software updates should be applied within a maintenance window.
`EnvironmentSummary`	`withSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)` An option to define if software updates should be applied within a maintenance window.
`EnvironmentSummary`	`withUpdatedAt(Date updatedAt)` The timestamp of when the device was updated.

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

- Constructor Detail
  - EnvironmentSummary
```
public EnvironmentSummary()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the environment.
    
    Parameters:
    
    id - The ID of the environment.
  - getId
```
public String getId()
```
    The ID of the environment.
    
    Returns:
    
    The ID of the environment.
  - withId
```
public EnvironmentSummary withId(String id)
```
    The ID of the environment.
    
    Parameters:
    
    id - The ID of the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the environment.
    
    Parameters:
    
    name - The name of the environment.
  - getName
```
public String getName()
```
    The name of the environment.
    
    Returns:
    
    The name of the environment.
  - withName
```
public EnvironmentSummary withName(String name)
```
    The name of the environment.
    
    Parameters:
    
    name - The name of the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesktopArn
```
public void setDesktopArn(String desktopArn)
```
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
    
    Parameters:
    
    desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - getDesktopArn
```
public String getDesktopArn()
```
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - withDesktopArn
```
public EnvironmentSummary withDesktopArn(String desktopArn)
```
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
    
    Parameters:
    
    desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesktopEndpoint
```
public void setDesktopEndpoint(String desktopEndpoint)
```
    The URL for the identity provider login (only for environments that use AppStream 2.0).
    
    Parameters:
    
    desktopEndpoint - The URL for the identity provider login (only for environments that use AppStream 2.0).
  - getDesktopEndpoint
```
public String getDesktopEndpoint()
```
    The URL for the identity provider login (only for environments that use AppStream 2.0).
    
    Returns:
    
    The URL for the identity provider login (only for environments that use AppStream 2.0).
  - withDesktopEndpoint
```
public EnvironmentSummary withDesktopEndpoint(String desktopEndpoint)
```
    The URL for the identity provider login (only for environments that use AppStream 2.0).
    
    Parameters:
    
    desktopEndpoint - The URL for the identity provider login (only for environments that use AppStream 2.0).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesktopType
```
public void setDesktopType(String desktopType)
```
    The type of streaming desktop for the environment.
    
    Parameters:
    
    desktopType - The type of streaming desktop for the environment.
    
    See Also:
    
    DesktopType
  - getDesktopType
```
public String getDesktopType()
```
    The type of streaming desktop for the environment.
    
    Returns:
    
    The type of streaming desktop for the environment.
    
    See Also:
    
    DesktopType
  - withDesktopType
```
public EnvironmentSummary withDesktopType(String desktopType)
```
    The type of streaming desktop for the environment.
    
    Parameters:
    
    desktopType - The type of streaming desktop for the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DesktopType
  - withDesktopType
```
public EnvironmentSummary withDesktopType(DesktopType desktopType)
```
    The type of streaming desktop for the environment.
    
    Parameters:
    
    desktopType - The type of streaming desktop for the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DesktopType
  - setActivationCode
```
public void setActivationCode(String activationCode)
```
    The activation code to register a device to the environment.
    
    Parameters:
    
    activationCode - The activation code to register a device to the environment.
  - getActivationCode
```
public String getActivationCode()
```
    The activation code to register a device to the environment.
    
    Returns:
    
    The activation code to register a device to the environment.
  - withActivationCode
```
public EnvironmentSummary withActivationCode(String activationCode)
```
    The activation code to register a device to the environment.
    
    Parameters:
    
    activationCode - The activation code to register a device to the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSoftwareSetUpdateSchedule
```
public void setSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)
```
    An option to define if software updates should be applied within a maintenance window.
    
    Parameters:
    
    softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - getSoftwareSetUpdateSchedule
```
public String getSoftwareSetUpdateSchedule()
```
    An option to define if software updates should be applied within a maintenance window.
    
    Returns:
    
    An option to define if software updates should be applied within a maintenance window.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - withSoftwareSetUpdateSchedule
```
public EnvironmentSummary withSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)
```
    An option to define if software updates should be applied within a maintenance window.
    
    Parameters:
    
    softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - withSoftwareSetUpdateSchedule
```
public EnvironmentSummary withSoftwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)
```
    An option to define if software updates should be applied within a maintenance window.
    
    Parameters:
    
    softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SoftwareSetUpdateSchedule
  - setMaintenanceWindow
```
public void setMaintenanceWindow(MaintenanceWindow maintenanceWindow)
```
    A specification for a time window to apply software updates.
    
    Parameters:
    
    maintenanceWindow - A specification for a time window to apply software updates.
  - getMaintenanceWindow
```
public MaintenanceWindow getMaintenanceWindow()
```
    A specification for a time window to apply software updates.
    
    Returns:
    
    A specification for a time window to apply software updates.
  - withMaintenanceWindow
```
public EnvironmentSummary withMaintenanceWindow(MaintenanceWindow maintenanceWindow)
```
    A specification for a time window to apply software updates.
    
    Parameters:
    
    maintenanceWindow - A specification for a time window to apply software updates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSoftwareSetUpdateMode
```
public void setSoftwareSetUpdateMode(String softwareSetUpdateMode)
```
    An option to define which software updates to apply.
    
    Parameters:
    
    softwareSetUpdateMode - An option to define which software updates to apply.
    
    See Also:
    
    SoftwareSetUpdateMode
  - getSoftwareSetUpdateMode
```
public String getSoftwareSetUpdateMode()
```
    An option to define which software updates to apply.
    
    Returns:
    
    An option to define which software updates to apply.
    
    See Also:
    
    SoftwareSetUpdateMode
  - withSoftwareSetUpdateMode
```
public EnvironmentSummary withSoftwareSetUpdateMode(String softwareSetUpdateMode)
```
    An option to define which software updates to apply.
    
    Parameters:
    
    softwareSetUpdateMode - An option to define which software updates to apply.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SoftwareSetUpdateMode
  - withSoftwareSetUpdateMode
```
public EnvironmentSummary withSoftwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)
```
    An option to define which software updates to apply.
    
    Parameters:
    
    softwareSetUpdateMode - An option to define which software updates to apply.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SoftwareSetUpdateMode
  - setDesiredSoftwareSetId
```
public void setDesiredSoftwareSetId(String desiredSoftwareSetId)
```
    The ID of the software set to apply.
    
    Parameters:
    
    desiredSoftwareSetId - The ID of the software set to apply.
  - getDesiredSoftwareSetId
```
public String getDesiredSoftwareSetId()
```
    The ID of the software set to apply.
    
    Returns:
    
    The ID of the software set to apply.
  - withDesiredSoftwareSetId
```
public EnvironmentSummary withDesiredSoftwareSetId(String desiredSoftwareSetId)
```
    The ID of the software set to apply.
    
    Parameters:
    
    desiredSoftwareSetId - The ID of the software set to apply.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingSoftwareSetId
```
public void setPendingSoftwareSetId(String pendingSoftwareSetId)
```
    The ID of the software set that is pending to be installed.
    
    Parameters:
    
    pendingSoftwareSetId - The ID of the software set that is pending to be installed.
  - getPendingSoftwareSetId
```
public String getPendingSoftwareSetId()
```
    The ID of the software set that is pending to be installed.
    
    Returns:
    
    The ID of the software set that is pending to be installed.
  - withPendingSoftwareSetId
```
public EnvironmentSummary withPendingSoftwareSetId(String pendingSoftwareSetId)
```
    The ID of the software set that is pending to be installed.
    
    Parameters:
    
    pendingSoftwareSetId - The ID of the software set that is pending to be installed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp of when the environment was created.
    
    Parameters:
    
    createdAt - The timestamp of when the environment was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp of when the environment was created.
    
    Returns:
    
    The timestamp of when the environment was created.
  - withCreatedAt
```
public EnvironmentSummary withCreatedAt(Date createdAt)
```
    The timestamp of when the environment was created.
    
    Parameters:
    
    createdAt - The timestamp of when the environment was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The timestamp of when the device was updated.
    
    Parameters:
    
    updatedAt - The timestamp of when the device was updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The timestamp of when the device was updated.
    
    Returns:
    
    The timestamp of when the device was updated.
  - withUpdatedAt
```
public EnvironmentSummary withUpdatedAt(Date updatedAt)
```
    The timestamp of when the device was updated.
    
    Parameters:
    
    updatedAt - The timestamp of when the device was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the environment.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the environment.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the environment.
  - withArn
```
public EnvironmentSummary withArn(String arn)
```
    The Amazon Resource Name (ARN) of the environment.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the environment.
    
    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 EnvironmentSummary 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class EnvironmentSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentSummary

Method Detail

setId

getId

withId

setName

getName

withName

setDesktopArn

getDesktopArn

withDesktopArn

setDesktopEndpoint

getDesktopEndpoint

withDesktopEndpoint

setDesktopType

getDesktopType

withDesktopType

withDesktopType

setActivationCode

getActivationCode

withActivationCode

setSoftwareSetUpdateSchedule

getSoftwareSetUpdateSchedule

withSoftwareSetUpdateSchedule

withSoftwareSetUpdateSchedule

setMaintenanceWindow

getMaintenanceWindow

withMaintenanceWindow

setSoftwareSetUpdateMode

getSoftwareSetUpdateMode

withSoftwareSetUpdateMode

withSoftwareSetUpdateMode

setDesiredSoftwareSetId

getDesiredSoftwareSetId

withDesiredSoftwareSetId

setPendingSoftwareSetId

getPendingSoftwareSetId

withPendingSoftwareSetId

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setArn

getArn

withArn

toString

equals

hashCode

clone

marshall