UpdateStudioComponentRequest (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.UpdateStudioComponentRequest

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

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

The studio component ID.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateStudioComponentRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateStudioComponentRequest.Builder`	`builder()`
`String`	`clientToken()` To make an idempotent API request using one of these actions, specify a client token in the request.
`StudioComponentConfiguration`	`configuration()` The configuration of the studio component, based on component type.
`String`	`description()` The description.
`List<String>`	`ec2SecurityGroupIds()` The EC2 security groups that control access to the studio component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEc2SecurityGroupIds()` Returns true if the Ec2SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInitializationScripts()` Returns true if the InitializationScripts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasScriptParameters()` Returns true if the ScriptParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<StudioComponentInitializationScript>`	`initializationScripts()` Initialization scripts for studio components.
`String`	`name()` The name for the studio component.
`List<ScriptParameterKeyValue>`	`scriptParameters()` Parameters for the studio component scripts.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateStudioComponentRequest.Builder>`	`serializableBuilderClass()`
`String`	`studioComponentId()` The studio component ID.
`String`	`studioId()` The studio ID.
`StudioComponentSubtype`	`subtype()` The specific subtype of a studio component.
`String`	`subtypeAsString()` The specific subtype of a studio component.
`UpdateStudioComponentRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`StudioComponentType`	`type()` The type of the studio component.
`String`	`typeAsString()` The type of the studio component.

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
  - 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.
  - configuration
```
public final StudioComponentConfiguration configuration()
```
    The configuration of the studio component, based on component type.
    
    Returns:
    
    The configuration of the studio component, based on component type.
  - description
```
public final String description()
```
    The description.
    
    Returns:
    
    The description.
  - hasEc2SecurityGroupIds
```
public final boolean hasEc2SecurityGroupIds()
```
    Returns true if the Ec2SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ec2SecurityGroupIds
```
public final List<String> ec2SecurityGroupIds()
```
    The EC2 security groups that control access to the studio component.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEc2SecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    The EC2 security groups that control access to the studio component.
  - hasInitializationScripts
```
public final boolean hasInitializationScripts()
```
    Returns true if the InitializationScripts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - initializationScripts
```
public final List<StudioComponentInitializationScript> initializationScripts()
```
    Initialization scripts for studio components.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInitializationScripts() to see if a value was sent in this field.
    
    Returns:
    
    Initialization scripts for studio components.
  - name
```
public final String name()
```
    The name for the studio component.
    
    Returns:
    
    The name for the studio component.
  - hasScriptParameters
```
public final boolean hasScriptParameters()
```
    Returns true if the ScriptParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - scriptParameters
```
public final List<ScriptParameterKeyValue> scriptParameters()
```
    Parameters for the studio component scripts.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasScriptParameters() to see if a value was sent in this field.
    
    Returns:
    
    Parameters for the studio component scripts.
  - studioComponentId
```
public final String studioComponentId()
```
    The studio component ID.
    
    Returns:
    
    The studio component ID.
  - studioId
```
public final String studioId()
```
    The studio ID.
    
    Returns:
    
    The studio ID.
  - subtype
```
public final StudioComponentSubtype subtype()
```
    The specific subtype of a studio component.
    
    If the service returns an enum value that is not available in the current SDK version, subtype will return StudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().
    
    Returns:
    
    The specific subtype of a studio component.
    
    See Also:
    
    StudioComponentSubtype
  - subtypeAsString
```
public final String subtypeAsString()
```
    The specific subtype of a studio component.
    
    If the service returns an enum value that is not available in the current SDK version, subtype will return StudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().
    
    Returns:
    
    The specific subtype of a studio component.
    
    See Also:
    
    StudioComponentSubtype
  - type
```
public final StudioComponentType type()
```
    The type of the studio component.
    
    If the service returns an enum value that is not available in the current SDK version, type will return StudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the studio component.
    
    See Also:
    
    StudioComponentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the studio component.
    
    If the service returns an enum value that is not available in the current SDK version, type will return StudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the studio component.
    
    See Also:
    
    StudioComponentType
  - toBuilder
```
public UpdateStudioComponentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateStudioComponentRequest.Builder,UpdateStudioComponentRequest>
    
    Specified by:
    
    toBuilder in class NimbleRequest
  - builder
```
public static UpdateStudioComponentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateStudioComponentRequest.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 UpdateStudioComponentRequest

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

clientToken

configuration

description

hasEc2SecurityGroupIds

ec2SecurityGroupIds

hasInitializationScripts

initializationScripts

name

hasScriptParameters

scriptParameters

studioComponentId

studioId

subtype

subtypeAsString

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields