Class UpdateStudioComponentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateStudioComponentRequest.Builder,
UpdateStudioComponentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.The configuration of the studio component, based on component type.final String
The description.The EC2 security groups that control access to the studio component.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InitializationScripts property.final boolean
For responses, this returns true if the service returned a value for the ScriptParameters property.Initialization scripts for studio components.final String
name()
The name for the studio component.final String
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.final List
<ScriptParameterKeyValue> Parameters for the studio component scripts.final String
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> final String
The studio component ID.final String
studioId()
The studio ID.final StudioComponentSubtype
subtype()
The specific subtype of a studio component.final String
The specific subtype of a studio component.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final StudioComponentType
type()
The type of the studio component.final String
The type of the studio component.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The configuration of the studio component, based on component type.
- Returns:
- The configuration of the studio component, based on component type.
-
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
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
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
The name for the studio component.
- Returns:
- The name for the studio component.
-
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
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
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
The studio component ID.
- Returns:
- The studio component ID.
-
studioId
The studio ID.
- Returns:
- The studio ID.
-
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 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:
-
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 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:
-
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 returnStudioComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the studio component.
- See Also:
-
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 returnStudioComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the studio component.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateStudioComponentRequest.Builder,
UpdateStudioComponentRequest> - Specified by:
toBuilder
in classNimbleRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-