Class DevEndpoint
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.DevEndpoint
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DevEndpoint.Builder,DevEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class DevEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DevEndpoint.Builder,DevEndpoint>
A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDevEndpoint.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.StringavailabilityZone()The Amazon Web Services Availability Zone where thisDevEndpointis located.static DevEndpoint.Builderbuilder()InstantcreatedTimestamp()The point in time at which this DevEndpoint was created.StringendpointName()The name of theDevEndpoint.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.StringfailureReason()The reason for a current failure in thisDevEndpoint.<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.InstantlastModifiedTimestamp()The point in time at which thisDevEndpointwas last modified.StringlastUpdateStatus()The status of the last update.IntegernumberOfNodes()The number of Glue Data Processing Units (DPUs) allocated to thisDevEndpoint.IntegernumberOfWorkers()The number of workers of a definedworkerTypethat are allocated to the development endpoint.StringprivateAddress()A private IP address to access theDevEndpointwithin a VPC if theDevEndpointis created within one.StringpublicAddress()The public IP address used by thisDevEndpoint.StringpublicKey()The public key to be used by thisDevEndpointfor authentication.List<String>publicKeys()A list of public keys to be used by theDevEndpointsfor authentication.StringroleArn()The Amazon Resource Name (ARN) of the IAM role used in thisDevEndpoint.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsecurityConfiguration()The name of theSecurityConfigurationstructure to be used with thisDevEndpoint.List<String>securityGroupIds()A list of security group identifiers used in thisDevEndpoint.static Class<? extends DevEndpoint.Builder>serializableBuilderClass()Stringstatus()The current status of thisDevEndpoint.StringsubnetId()The subnet ID for thisDevEndpoint.DevEndpoint.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()The ID of the virtual private cloud (VPC) used by thisDevEndpoint.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.StringyarnEndpointAddress()The YARN endpoint address used by thisDevEndpoint.IntegerzeppelinRemoteSparkInterpreterPort()The Apache Zeppelin port for the remote Apache Spark interpreter.-
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 of the
DevEndpoint.- Returns:
- The name of the
DevEndpoint.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role used in this
DevEndpoint.- Returns:
- The Amazon Resource Name (ARN) of the IAM role used in this
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()
A list of security group identifiers used in this
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:
- A list of security group identifiers used in this
DevEndpoint.
-
subnetId
public final String subnetId()
The subnet ID for this
DevEndpoint.- Returns:
- The subnet ID for this
DevEndpoint.
-
yarnEndpointAddress
public final String yarnEndpointAddress()
The YARN endpoint address used by this
DevEndpoint.- Returns:
- The YARN endpoint address used by this
DevEndpoint.
-
privateAddress
public final String privateAddress()
A private IP address to access the
DevEndpointwithin a VPC if theDevEndpointis created within one. ThePrivateAddressfield is present only when you create theDevEndpointwithin your VPC.- Returns:
- A private IP address to access the
DevEndpointwithin a VPC if theDevEndpointis created within one. ThePrivateAddressfield is present only when you create theDevEndpointwithin your VPC.
-
zeppelinRemoteSparkInterpreterPort
public final Integer zeppelinRemoteSparkInterpreterPort()
The Apache Zeppelin port for the remote Apache Spark interpreter.
- Returns:
- The Apache Zeppelin port for the remote Apache Spark interpreter.
-
publicAddress
public final String publicAddress()
The public IP address used by this
DevEndpoint. ThePublicAddressfield is present only when you create a non-virtual private cloud (VPC)DevEndpoint.- Returns:
- The public IP address used by this
DevEndpoint. ThePublicAddressfield is present only when you create a non-virtual private cloud (VPC)DevEndpoint.
-
status
public final String status()
The current status of this
DevEndpoint.- Returns:
- The current status of 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.
-
numberOfNodes
public final Integer numberOfNodes()
The number of Glue Data Processing Units (DPUs) allocated to this
DevEndpoint.- Returns:
- The number of Glue Data Processing Units (DPUs) allocated to this
DevEndpoint.
-
availabilityZone
public final String availabilityZone()
The Amazon Web Services Availability Zone where this
DevEndpointis located.- Returns:
- The Amazon Web Services Availability Zone where this
DevEndpointis located.
-
vpcId
public final String vpcId()
The ID of the virtual private cloud (VPC) used by this
DevEndpoint.- Returns:
- The ID of the virtual private cloud (VPC) used by this
DevEndpoint.
-
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 currently 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 currently supported.
-
extraJarsS3Path
public final String extraJarsS3Path()
The path to one or more Java
.jarfiles in an S3 bucket that should be loaded in yourDevEndpoint.You can only use pure Java/Scala libraries with a
DevEndpoint.- Returns:
- The path to one or more Java
.jarfiles in an S3 bucket that should be loaded in yourDevEndpoint.You can only use pure Java/Scala libraries with a
DevEndpoint.
-
failureReason
public final String failureReason()
The reason for a current failure in this
DevEndpoint.- Returns:
- The reason for a current failure in this
DevEndpoint.
-
lastUpdateStatus
public final String lastUpdateStatus()
The status of the last update.
- Returns:
- The status of the last update.
-
createdTimestamp
public final Instant createdTimestamp()
The point in time at which this DevEndpoint was created.
- Returns:
- The point in time at which this DevEndpoint was created.
-
lastModifiedTimestamp
public final Instant lastModifiedTimestamp()
The point in time at which this
DevEndpointwas last modified.- Returns:
- The point in time at which this
DevEndpointwas last modified.
-
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
DevEndpointsfor authentication. Using 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 operation 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
DevEndpointsfor authentication. Using 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 operation with the public key content in thedeletePublicKeysattribute, and the list of new keys in theaddPublicKeysattribute.
-
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.
-
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.Valid arguments are:
-
"--enable-glue-datacatalog": ""
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.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.Valid arguments are:
-
"--enable-glue-datacatalog": ""
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. -
-
-
toBuilder
public DevEndpoint.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DevEndpoint.Builder,DevEndpoint>
-
builder
public static DevEndpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends DevEndpoint.Builder> serializableBuilderClass()
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-