DevEndpoint (AWS Java SDK :: Services :: AWS Glue 2.15.32 API)

java.lang.Object
- software.amazon.awssdk.services.glue.model.DevEndpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DevEndpoint.Builder,DevEndpoint>
```
@Generated(value="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 and Description

static interface DevEndpoint.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`arguments()` A map of arguments used to configure the `DevEndpoint`.
`String`	`availabilityZone()` The AWS Availability Zone where this `DevEndpoint` is located.
`static DevEndpoint.Builder`	`builder()`
`Instant`	`createdTimestamp()` The point in time at which this DevEndpoint was created.
`String`	`endpointName()` The name of the `DevEndpoint`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`extraJarsS3Path()` The path to one or more Java `.jar` files in an S3 bucket that should be loaded in your `DevEndpoint`.
`String`	`extraPythonLibsS3Path()` The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint`.
`String`	`failureReason()` The reason for a current failure in this `DevEndpoint`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`glueVersion()` Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
`boolean`	`hasArguments()` Returns true if the Arguments 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`	`hasPublicKeys()` Returns true if the PublicKeys 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`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Instant`	`lastModifiedTimestamp()` The point in time at which this `DevEndpoint` was last modified.
`String`	`lastUpdateStatus()` The status of the last update.
`Integer`	`numberOfNodes()` The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint`.
`Integer`	`numberOfWorkers()` The number of workers of a defined `workerType` that are allocated to the development endpoint.
`String`	`privateAddress()` A private IP address to access the `DevEndpoint` within a VPC if the `DevEndpoint` is created within one.
`String`	`publicAddress()` The public IP address used by this `DevEndpoint`.
`String`	`publicKey()` The public key to be used by this `DevEndpoint` for authentication.
`List<String>`	`publicKeys()` A list of public keys to be used by the `DevEndpoints` for authentication.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint`.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityConfiguration()` The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint`.
`List<String>`	`securityGroupIds()` A list of security group identifiers used in this `DevEndpoint`.
`static Class<? extends DevEndpoint.Builder>`	`serializableBuilderClass()`
`String`	`status()` The current status of this `DevEndpoint`.
`String`	`subnetId()` The subnet ID for this `DevEndpoint`.
`DevEndpoint.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The ID of the virtual private cloud (VPC) used by this `DevEndpoint`.
`WorkerType`	`workerType()` The type of predefined worker that is allocated to the development endpoint.
`String`	`workerTypeAsString()` The type of predefined worker that is allocated to the development endpoint.
`String`	`yarnEndpointAddress()` The YARN endpoint address used by this `DevEndpoint`.
`Integer`	`zeppelinRemoteSparkInterpreterPort()` 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 String endpointName()
```
    The name of the DevEndpoint.
    
    Returns:
    
    The name of the DevEndpoint.
  - roleArn
```
public 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 boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds 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.
  - securityGroupIds
```
public 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.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    A list of security group identifiers used in this DevEndpoint.
  - subnetId
```
public String subnetId()
```
    The subnet ID for this DevEndpoint.
    
    Returns:
    
    The subnet ID for this DevEndpoint.
  - yarnEndpointAddress
```
public String yarnEndpointAddress()
```
    The YARN endpoint address used by this DevEndpoint.
    
    Returns:
    
    The YARN endpoint address used by this DevEndpoint.
  - privateAddress
```
public String privateAddress()
```
    A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
    
    Returns:
    
    A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.
  - zeppelinRemoteSparkInterpreterPort
```
public 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 String publicAddress()
```
    The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.
    
    Returns:
    
    The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.
  - status
```
public String status()
```
    The current status of this DevEndpoint.
    
    Returns:
    
    The current status of this DevEndpoint.
  - workerType
```
public 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 Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    - For the G.1X worker 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.2X worker 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.2X WorkerType configuration, 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, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    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 Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    
    For the G.1X worker 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.2X worker 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.2X WorkerType configuration, 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 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 Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    - For the G.1X worker 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.2X worker 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.2X WorkerType configuration, 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, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    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 Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
    
    For the G.1X worker 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.2X worker 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.2X WorkerType configuration, 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 String glueVersion()
```
    Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
    
    For more information about the available AWS 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 Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
    
    Returns:
    
    Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
    
    For more information about the available AWS 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 Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
  - numberOfWorkers
```
public Integer numberOfWorkers()
```
    The number of workers of a defined workerType that are allocated to the development endpoint.
    
    The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
    
    Returns:
    
    The number of workers of a defined workerType that are allocated to the development endpoint.
    
    The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
  - numberOfNodes
```
public Integer numberOfNodes()
```
    The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
    
    Returns:
    
    The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
  - availabilityZone
```
public String availabilityZone()
```
    The AWS Availability Zone where this DevEndpoint is located.
    
    Returns:
    
    The AWS Availability Zone where this DevEndpoint is located.
  - vpcId
```
public 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 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 String extraJarsS3Path()
```
    The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
    
    You can only use pure Java/Scala libraries with a DevEndpoint.
    
    Returns:
    
    The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
    
    You can only use pure Java/Scala libraries with a DevEndpoint.
  - failureReason
```
public String failureReason()
```
    The reason for a current failure in this DevEndpoint.
    
    Returns:
    
    The reason for a current failure in this DevEndpoint.
  - lastUpdateStatus
```
public String lastUpdateStatus()
```
    The status of the last update.
    
    Returns:
    
    The status of the last update.
  - createdTimestamp
```
public 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 Instant lastModifiedTimestamp()
```
    The point in time at which this DevEndpoint was last modified.
    
    Returns:
    
    The point in time at which this DevEndpoint was last modified.
  - publicKey
```
public String publicKey()
```
    The public key to be used by this DevEndpoint for 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 DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
  - hasPublicKeys
```
public boolean hasPublicKeys()
```
    Returns true if the PublicKeys 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.
  - publicKeys
```
public List<String> publicKeys()
```
    A list of public keys to be used by the DevEndpoints for 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 UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPublicKeys() to see if a value was sent in this field.
    
    Returns:
    
    A list of public keys to be used by the DevEndpoints for 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 UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
  - securityConfiguration
```
public String securityConfiguration()
```
    The name of the SecurityConfiguration structure to be used with this DevEndpoint.
    
    Returns:
    
    The name of the SecurityConfiguration structure to be used with this DevEndpoint.
  - hasArguments
```
public boolean hasArguments()
```
    Returns true if the Arguments 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.
  - arguments
```
public Map<String,String> arguments()
```
    A map of arguments used to configure the DevEndpoint.
    
    Valid arguments are:
    - "--enable-glue-datacatalog": ""
    - "GLUE_PYTHON_VERSION": "3"
    - "GLUE_PYTHON_VERSION": "2"
    You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. 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.
    
    You can use hasArguments() to see if a value was sent in this field.
    Returns:
    A map of arguments used to configure the DevEndpoint.
    
    Valid arguments are:
    
    "--enable-glue-datacatalog": ""
    
    "GLUE_PYTHON_VERSION": "3"
    
    "GLUE_PYTHON_VERSION": "2"
    
    You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.
  - toBuilder
```
public DevEndpoint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DevEndpoint.Builder,DevEndpoint>
  - builder
```
public static DevEndpoint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DevEndpoint.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DevEndpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

endpointName

roleArn

hasSecurityGroupIds

securityGroupIds

subnetId

yarnEndpointAddress

privateAddress

zeppelinRemoteSparkInterpreterPort

publicAddress

status

workerType

workerTypeAsString

glueVersion

numberOfWorkers

numberOfNodes

availabilityZone

vpcId

extraPythonLibsS3Path

extraJarsS3Path

failureReason

lastUpdateStatus

createdTimestamp

lastModifiedTimestamp

publicKey

hasPublicKeys

publicKeys

securityConfiguration

hasArguments

arguments

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields