Class CreateDevEndpointRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.glue.model.GlueRequest
-
- software.amazon.awssdk.services.glue.model.CreateDevEndpointRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDevEndpointRequest.Builder,CreateDevEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDevEndpointRequest extends GlueRequest implements ToCopyableBuilder<CreateDevEndpointRequest.Builder,CreateDevEndpointRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDevEndpointRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>arguments()A map of arguments used to configure theDevEndpoint.static CreateDevEndpointRequest.Builderbuilder()StringendpointName()The name to be assigned to the newDevEndpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringextraJarsS3Path()The path to one or more Java.jarfiles in an S3 bucket that should be loaded in yourDevEndpoint.StringextraPythonLibsS3Path()The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in yourDevEndpoint.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)StringglueVersion()Glue version determines the versions of Apache Spark and Python that Glue supports.booleanhasArguments()For responses, this returns true if the service returned a value for the Arguments property.inthashCode()booleanhasPublicKeys()For responses, this returns true if the service returned a value for the PublicKeys property.booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.IntegernumberOfNodes()The number of Glue Data Processing Units (DPUs) to allocate to thisDevEndpoint.IntegernumberOfWorkers()The number of workers of a definedworkerTypethat are allocated to the development endpoint.StringpublicKey()The public key to be used by thisDevEndpointfor authentication.List<String>publicKeys()A list of public keys to be used by the development endpoints for authentication.StringroleArn()The IAM role for theDevEndpoint.List<SdkField<?>>sdkFields()StringsecurityConfiguration()The name of theSecurityConfigurationstructure to be used with thisDevEndpoint.List<String>securityGroupIds()Security group IDs for the security groups to be used by the newDevEndpoint.static Class<? extends CreateDevEndpointRequest.Builder>serializableBuilderClass()StringsubnetId()The subnet ID for the newDevEndpointto use.Map<String,String>tags()The tags to use with this DevEndpoint.CreateDevEndpointRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.WorkerTypeworkerType()The type of predefined worker that is allocated to the development endpoint.StringworkerTypeAsString()The type of predefined worker that is allocated to the development endpoint.-
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
-
endpointName
public final String endpointName()
The name to be assigned to the new
DevEndpoint.- Returns:
- The name to be assigned to the new
DevEndpoint.
-
roleArn
public final String roleArn()
The IAM role for the
DevEndpoint.- Returns:
- The IAM role for the
DevEndpoint.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()
For responses, this returns true if the service returned a value for the SecurityGroupIds 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.
-
securityGroupIds
public final List<String> securityGroupIds()
Security group IDs for the security groups to be used by the new
DevEndpoint.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
hasSecurityGroupIds()method.- Returns:
- Security group IDs for the security groups to be used by the new
DevEndpoint.
-
subnetId
public final String subnetId()
The subnet ID for the new
DevEndpointto use.- Returns:
- The subnet ID for the new
DevEndpointto use.
-
publicKey
public final String publicKey()
The public key to be used by this
DevEndpointfor authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.- Returns:
- The public key to be used by this
DevEndpointfor authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
-
hasPublicKeys
public final boolean hasPublicKeys()
For responses, this returns true if the service returned a value for the PublicKeys 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.
-
publicKeys
public final List<String> publicKeys()
A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the
UpdateDevEndpointAPI with the public key content in thedeletePublicKeysattribute, and the list of new keys in theaddPublicKeysattribute.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
hasPublicKeys()method.- Returns:
- A list of public keys to be used by the development endpoints for authentication. The use of this
attribute is preferred over a single public key because the public keys allow you to have a different
private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the
UpdateDevEndpointAPI with the public key content in thedeletePublicKeysattribute, and the list of new keys in theaddPublicKeysattribute.
-
numberOfNodes
public final Integer numberOfNodes()
The number of Glue Data Processing Units (DPUs) to allocate to this
DevEndpoint.- Returns:
- The number of Glue Data Processing Units (DPUs) to allocate to this
DevEndpoint.
-
workerType
public final WorkerType workerType()
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standardworker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1Xworker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2Xworker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
G.2XWorkerTypeconfiguration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.If the service returns an enum value that is not available in the current SDK version,
workerTypewill returnWorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromworkerTypeAsString().- Returns:
- The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard,
G.1X, or G.2X.
-
For the
Standardworker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1Xworker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2Xworker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
G.2XWorkerTypeconfiguration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. -
- See Also:
WorkerType
-
-
workerTypeAsString
public final String workerTypeAsString()
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standardworker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1Xworker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2Xworker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
G.2XWorkerTypeconfiguration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.If the service returns an enum value that is not available in the current SDK version,
workerTypewill returnWorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromworkerTypeAsString().- Returns:
- The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard,
G.1X, or G.2X.
-
For the
Standardworker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1Xworker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2Xworker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
G.2XWorkerTypeconfiguration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. -
- See Also:
WorkerType
-
-
glueVersion
public final String glueVersion()
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Argumentsparameter in theCreateDevEndpointorUpdateDevEndpointAPIs. If no arguments are provided, the version defaults to Python 2.- Returns:
- Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version
indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Argumentsparameter in theCreateDevEndpointorUpdateDevEndpointAPIs. If no arguments are provided, the version defaults to Python 2.
-
numberOfWorkers
public final Integer numberOfWorkers()
The number of workers of a defined
workerTypethat are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X, and 149 forG.2X.- Returns:
- The number of workers of a defined
workerTypethat are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X, and 149 forG.2X.
-
extraPythonLibsS3Path
public final String extraPythonLibsS3Path()
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint. Multiple values must be complete paths separated by a comma.You can only use pure Python libraries with a
DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.- Returns:
- The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint. Multiple values must be complete paths separated by a comma.You can only use pure Python libraries with a
DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
-
extraJarsS3Path
public final String extraJarsS3Path()
The path to one or more Java
.jarfiles in an S3 bucket that should be loaded in yourDevEndpoint.- Returns:
- The path to one or more Java
.jarfiles in an S3 bucket that should be loaded in yourDevEndpoint.
-
securityConfiguration
public final String securityConfiguration()
The name of the
SecurityConfigurationstructure to be used with thisDevEndpoint.- Returns:
- The name of the
SecurityConfigurationstructure to be used with thisDevEndpoint.
-
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 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.
-
tags
public final Map<String,String> tags()
The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
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 to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
-
hasArguments
public final boolean hasArguments()
For responses, this returns true if the service returned a value for the Arguments 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.
-
arguments
public final Map<String,String> arguments()
A map of arguments used to configure the
DevEndpoint.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
hasArguments()method.- Returns:
- A map of arguments used to configure the
DevEndpoint.
-
toBuilder
public CreateDevEndpointRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDevEndpointRequest.Builder,CreateDevEndpointRequest>- Specified by:
toBuilderin classGlueRequest
-
builder
public static CreateDevEndpointRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDevEndpointRequest.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
-
-