ClientConfig.Field (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- java.lang.Enum<ClientConfig.Field>
- - oracle.pgx.config.ClientConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClientConfig.Field>, ConfigField

Enclosing class:

ClientConfig
```
public static enum ClientConfig.Field
extends java.lang.Enum<ClientConfig.Field>
implements ConfigField
```
Fields of PGX Engine Client Config

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCESS_TOKEN` the authentication token (if server requires authentication)
`BASE_URL` The base url in the format `host [ : port][ /path]` of the PGX server REST end-point.
`CCTRACE_OUT` [relevant for `enable_cctrace`] when cctrace is enabled, specifies a path to a file where cctrace should log to.
`CCTRACE_PRINT_STACKTRACES` [relevant for `enable_cctrace`] when cctrace is enabled, print the stacktrace for each request and result
`CLIENT_SERVER_INTERACTION_MODE` if `async_polling` the PGX client would poll the status of the future until it's completed.
`ENABLE_CCTRACE` if `true` log every call to a Control or Core interface
`KEYSTORE` path to the keystore to use for client connections.
`MAX_CLIENT_HTTP_CONNECTIONS` Maximum number of connections to open to the PGX server
`PASSWORD` if username is given, this is the HTTP BASIC Auth password.
`PREFETCH_SIZE` How many items should be prefetched in remote iterators.
`REMOTE_FUTURE_PENDING_RETRY_INTERVAL` How many milliseconds to wait before sending another request in case a `GET` request for a `PgxRemoteFuture` receives a 202 - Accepted response
`REMOTE_FUTURE_TIMEOUT` How long one `GET` request for a `PgxRemoteFuture` will be alive, until it times out and tries again.
`TLS_VERSION` TLS version to be used by the client.
`TRUSTSTORE` path to the truststore to use for client connections.
`UPLOAD_BATCH_SIZE` How many items will be uploaded in a batch.
`USERNAME` The username (if server requires HTTP BASIC authentication)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getDefaultVal()` Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()` Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()` Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.Class<?>`	`getType()` Gets the type of this field.
`boolean`	`isArray()` Checks if this field is an array.
`boolean`	`isHidden()` Checks if this field should be hidden.
`boolean`	`isPath()` Checks if this field is a path.
`boolean`	`isRequired()` Checks if this field is required.
`boolean`	`isSensitive()` Checks if this field holds a sensitive data.
`java.lang.String`	`toKey()` Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static ClientConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ClientConfig.Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - ACCESS_TOKEN
```
public static final ClientConfig.Field ACCESS_TOKEN
```
    the authentication token (if server requires authentication)
  - BASE_URL
```
public static final ClientConfig.Field BASE_URL
```
    The base url in the format host [ : port][ /path] of the PGX server REST end-point. If the base_url is null, the default will be used which points to embedded PGX instance.
  - CCTRACE_OUT
```
public static final ClientConfig.Field CCTRACE_OUT
```
    [relevant for enable_cctrace] when cctrace is enabled, specifies a path to a file where cctrace should log to. If null it will use the default PGX logger on level TRACE. If it is the special value :stderr: it will log to stderr
  - CCTRACE_PRINT_STACKTRACES
```
public static final ClientConfig.Field CCTRACE_PRINT_STACKTRACES
```
    [relevant for enable_cctrace] when cctrace is enabled, print the stacktrace for each request and result
  - CLIENT_SERVER_INTERACTION_MODE
```
public static final ClientConfig.Field CLIENT_SERVER_INTERACTION_MODE
```
    if async_polling the PGX client would poll the status of the future until it's completed. If blocking the PGX client would send a request to directly get the value of the future and the server would block until the future result is ready
  - ENABLE_CCTRACE
```
public static final ClientConfig.Field ENABLE_CCTRACE
```
    if true log every call to a Control or Core interface
  - KEYSTORE
```
public static final ClientConfig.Field KEYSTORE
```
    path to the keystore to use for client connections. The keystore is used to authenticate this client at the PGX server if two-way SSL/TLS is enabled.
  - MAX_CLIENT_HTTP_CONNECTIONS
```
public static final ClientConfig.Field MAX_CLIENT_HTTP_CONNECTIONS
```
    Maximum number of connections to open to the PGX server
  - PASSWORD
```
public static final ClientConfig.Field PASSWORD
```
    if username is given, this is the HTTP BASIC Auth password. If keystore is given, this is the keystore password.
  - PREFETCH_SIZE
```
public static final ClientConfig.Field PREFETCH_SIZE
```
    How many items should be prefetched in remote iterators.
  - REMOTE_FUTURE_PENDING_RETRY_INTERVAL
```
public static final ClientConfig.Field REMOTE_FUTURE_PENDING_RETRY_INTERVAL
```
    How many milliseconds to wait before sending another request in case a GET request for a PgxRemoteFuture receives a 202 - Accepted response
  - REMOTE_FUTURE_TIMEOUT
```
public static final ClientConfig.Field REMOTE_FUTURE_TIMEOUT
```
    How long one GET request for a PgxRemoteFuture will be alive, until it times out and tries again. Time in milliseconds, set it to zero for an infinite timeout. See HTTP Client SO_TIMEOUT for more details.
  - TLS_VERSION
```
public static final ClientConfig.Field TLS_VERSION
```
    TLS version to be used by the client. For example, TLSv1.2
  - TRUSTSTORE
```
public static final ClientConfig.Field TRUSTSTORE
```
    path to the truststore to use for client connections. The truststore is used to validate the server certificate if communicating over SSL/TLS.
  - UPLOAD_BATCH_SIZE
```
public static final ClientConfig.Field UPLOAD_BATCH_SIZE
```
    How many items will be uploaded in a batch. This is used in Core#addAllToCollection() and Core#setProperty()
  - USERNAME
```
public static final ClientConfig.Field USERNAME
```
    The username (if server requires HTTP BASIC authentication)
- Method Detail
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - getKeyAliases
```
public java.util.List<java.lang.String> getKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which are also recognized during parsing.
    
    Specified by:
    
    getKeyAliases in interface ConfigField
    
    Returns:
    
    the key aliases
  - getSingletonListKeyAliases
```
public java.util.List<java.lang.String> getSingletonListKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    
    Specified by:
    
    getSingletonListKeyAliases in interface ConfigField
    
    Returns:
    
    the singleton list key aliases
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: ConfigField
    
    Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
    
    Specified by:
    
    isHidden in interface ConfigField
    
    Returns:
    
    true if field should be hidden, false otherwise
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - toKey
```
public java.lang.String toKey()
```
    Description copied from interface: ConfigField
    
    Get the key of this field, which is how this field is represented in serialized form.
    
    Specified by:
    
    toKey in interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<ClientConfig.Field>
  - valueOf
```
public static ClientConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - values
```
public static ClientConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ClientConfig.Field c : ClientConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum ClientConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

ACCESS_TOKEN

BASE_URL

CCTRACE_OUT

CCTRACE_PRINT_STACKTRACES

CLIENT_SERVER_INTERACTION_MODE

ENABLE_CCTRACE

KEYSTORE

MAX_CLIENT_HTTP_CONNECTIONS

PASSWORD

PREFETCH_SIZE

REMOTE_FUTURE_PENDING_RETRY_INTERVAL

REMOTE_FUTURE_TIMEOUT

TLS_VERSION

TRUSTSTORE

UPLOAD_BATCH_SIZE

USERNAME

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values