CreateStudioRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.nimble.model.NimbleRequest
    - - software.amazon.awssdk.services.nimble.model.CreateStudioRequest

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

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStudioRequest
extends NimbleRequest
implements ToCopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>

A collection of studio resources.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateStudioRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateStudioRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`adminRoleArn()` The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
`static CreateStudioRequest.Builder`	`builder()`
`String`	`clientToken()` To make an idempotent API request using one of these actions, specify a client token in the request.
`String`	`displayName()` A friendly name for the studio.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStudioRequest.Builder>`	`serializableBuilderClass()`
`StudioEncryptionConfiguration`	`studioEncryptionConfiguration()` The studio encryption configuration.
`String`	`studioName()` The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
`Map<String,String>`	`tags()` A collection of labels, in the form of key:value pairs, that apply to this resource.
`CreateStudioRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userRoleArn()` The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

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
  - adminRoleArn
```
public final String adminRoleArn()
```
    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
  - clientToken
```
public final String clientToken()
```
    To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.
    
    Returns:
    
    To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.
  - displayName
```
public final String displayName()
```
    A friendly name for the studio.
    
    Returns:
    
    A friendly name for the studio.
  - studioEncryptionConfiguration
```
public final StudioEncryptionConfiguration studioEncryptionConfiguration()
```
    The studio encryption configuration.
    
    Returns:
    
    The studio encryption configuration.
  - studioName
```
public final String studioName()
```
    The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
    
    Returns:
    
    The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
  - 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()
```
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    
    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:
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
  - userRoleArn
```
public final String userRoleArn()
```
    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
  - toBuilder
```
public CreateStudioRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>
    
    Specified by:
    
    toBuilder in class NimbleRequest
  - builder
```
public static CreateStudioRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateStudioRequest.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 CreateStudioRequest

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

adminRoleArn

clientToken

displayName

studioEncryptionConfiguration

studioName

hasTags

tags

userRoleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields