Class UpdateStudioComponentRequest
- 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("software.amazon.awssdk:codegen") public final class UpdateStudioComponentRequest extends NimbleRequest implements ToCopyableBuilder<UpdateStudioComponentRequest.Builder,UpdateStudioComponentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateStudioComponentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateStudioComponentRequest.Builderbuilder()StringclientToken()Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.StudioComponentConfigurationconfiguration()The configuration of the studio component, based on component type.Stringdescription()The description.List<String>ec2SecurityGroupIds()The EC2 security groups that control access to the studio component.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEc2SecurityGroupIds()For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property.inthashCode()booleanhasInitializationScripts()For responses, this returns true if the service returned a value for the InitializationScripts property.booleanhasScriptParameters()For responses, this returns true if the service returned a value for the ScriptParameters property.List<StudioComponentInitializationScript>initializationScripts()Initialization scripts for studio components.Stringname()The name for the studio component.StringruntimeRoleArn()An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.List<ScriptParameterKeyValue>scriptParameters()Parameters for the studio component scripts.List<SdkField<?>>sdkFields()StringsecureInitializationRoleArn()An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.static Class<? extends UpdateStudioComponentRequest.Builder>serializableBuilderClass()StringstudioComponentId()The studio component ID.StringstudioId()The studio ID.StudioComponentSubtypesubtype()The specific subtype of a studio component.StringsubtypeAsString()The specific subtype of a studio component.UpdateStudioComponentRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StudioComponentTypetype()The type of the studio component.StringtypeAsString()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()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
- Returns:
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
-
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()
For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
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.
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
hasEc2SecurityGroupIds()method.- Returns:
- The EC2 security groups that control access to the studio component.
-
hasInitializationScripts
public final boolean hasInitializationScripts()
For responses, this returns true if the service returned a value for the InitializationScripts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
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.
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
hasInitializationScripts()method.- Returns:
- Initialization scripts for studio components.
-
name
public final String name()
The name for the studio component.
- Returns:
- The name for the studio component.
-
runtimeRoleArn
public final String runtimeRoleArn()
An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
- Returns:
- An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
-
hasScriptParameters
public final boolean hasScriptParameters()
For responses, this returns true if the service returned a value for the ScriptParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
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.
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
hasScriptParameters()method.- Returns:
- Parameters for the studio component scripts.
-
secureInitializationRoleArn
public final String secureInitializationRoleArn()
An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
- Returns:
- An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
-
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,
subtypewill returnStudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubtypeAsString().- 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,
subtypewill returnStudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubtypeAsString().- 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,
typewill returnStudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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,
typewill returnStudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the studio component.
- See Also:
StudioComponentType
-
toBuilder
public UpdateStudioComponentRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateStudioComponentRequest.Builder,UpdateStudioComponentRequest>- Specified by:
toBuilderin classNimbleRequest
-
builder
public static UpdateStudioComponentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateStudioComponentRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-