java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest
    - - software.amazon.awssdk.services.workspaces.model.RegisterWorkspaceDirectoryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RegisterWorkspaceDirectoryRequest
extends WorkSpacesRequest
implements ToCopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RegisterWorkspaceDirectoryRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RegisterWorkspaceDirectoryRequest.Builder`	`builder()`
`String`	`directoryId()`	The identifier of the directory.
`Boolean`	`enableSelfService()`	Indicates whether self-service capabilities are enabled or disabled.
`Boolean`	`enableWorkDocs()`	Indicates whether Amazon WorkDocs is enabled or disabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubnetIds()`	For responses, this returns true if the service returned a value for the SubnetIds property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterWorkspaceDirectoryRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnetIds()`	The identifiers of the subnets for your virtual private cloud (VPC).
`List<Tag>`	`tags()`	The tags associated with the directory.
`Tenancy`	`tenancy()`	Indicates whether your WorkSpace directory is dedicated or shared.
`String`	`tenancyAsString()`	Indicates whether your WorkSpace directory is dedicated or shared.
`RegisterWorkspaceDirectoryRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - directoryId
```
public final String directoryId()
```
    The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
    
    Returns:
    
    The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds 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.
  - subnetIds
```
public final List<String> subnetIds()
```
    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
    
    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 hasSubnetIds() method.
    
    Returns:
    
    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
  - enableWorkDocs
```
public final Boolean enableWorkDocs()
```
    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
    
    Returns:
    
    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
  - enableSelfService
```
public final Boolean enableSelfService()
```
    Indicates whether self-service capabilities are enabled or disabled.
    
    Returns:
    
    Indicates whether self-service capabilities are enabled or disabled.
  - tenancy
```
public final Tenancy tenancy()
```
    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
    
    See Also:
    
    Tenancy
  - tenancyAsString
```
public final String tenancyAsString()
```
    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
    
    See Also:
    
    Tenancy
  - 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 associated with the directory.
    
    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 associated with the directory.
  - toBuilder
```
public RegisterWorkspaceDirectoryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>
    
    Specified by:
    
    toBuilder in class WorkSpacesRequest
  - builder
```
public static RegisterWorkspaceDirectoryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterWorkspaceDirectoryRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterWorkspaceDirectoryRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

directoryId

hasSubnetIds

subnetIds

enableWorkDocs

enableSelfService

tenancy

tenancyAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields