com.datadog.api.client.v1.model

Class SyntheticsBasicAuthJWT

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsBasicAuthJWT

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SyntheticsBasicAuthJWT
extends Object

Object to handle JWT authentication when performing the test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ADD_CLAIMS
static String	JSON_PROPERTY_ALGORITHM
static String	JSON_PROPERTY_EXPIRES_IN
static String	JSON_PROPERTY_HEADER
static String	JSON_PROPERTY_PAYLOAD
static String	JSON_PROPERTY_SECRET
static String	JSON_PROPERTY_TOKEN_PREFIX
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsBasicAuthJWT()
SyntheticsBasicAuthJWT(SyntheticsBasicAuthJWTAlgorithm algorithm, String payload, String secret, SyntheticsBasicAuthJWTType type)

Method Summary

Modifier and Type	Method and Description
SyntheticsBasicAuthJWT	addClaims(SyntheticsBasicAuthJWTAddClaims addClaims)
SyntheticsBasicAuthJWT	algorithm(SyntheticsBasicAuthJWTAlgorithm algorithm)
boolean	equals(Object o) Return true if this SyntheticsBasicAuthJWT object is equal to o.
SyntheticsBasicAuthJWT	expiresIn(Long expiresIn)
SyntheticsBasicAuthJWTAddClaims	getAddClaims() Standard JWT claims to automatically inject.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
SyntheticsBasicAuthJWTAlgorithm	getAlgorithm() Algorithm to use for the JWT authentication.
Long	getExpiresIn() Token time-to-live in seconds.
String	getHeader() Custom JWT header as a JSON string.
String	getPayload() JWT claims as a JSON string.
String	getSecret() Signing key for the JWT authentication.
String	getTokenPrefix() Prefix added before the token in the Authorization header.
SyntheticsBasicAuthJWTType	getType() The type of authentication to use when performing the test.
int	hashCode()
SyntheticsBasicAuthJWT	header(String header)
SyntheticsBasicAuthJWT	payload(String payload)
SyntheticsBasicAuthJWT	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsBasicAuthJWT	secret(String secret)
void	setAddClaims(SyntheticsBasicAuthJWTAddClaims addClaims)
void	setAlgorithm(SyntheticsBasicAuthJWTAlgorithm algorithm)
void	setExpiresIn(Long expiresIn)
void	setHeader(String header)
void	setPayload(String payload)
void	setSecret(String secret)
void	setTokenPrefix(String tokenPrefix)
void	setType(SyntheticsBasicAuthJWTType type)
SyntheticsBasicAuthJWT	tokenPrefix(String tokenPrefix)
String	toString()
SyntheticsBasicAuthJWT	type(SyntheticsBasicAuthJWTType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ADD_CLAIMS

public static final String JSON_PROPERTY_ADD_CLAIMS

See Also:

Constant Field Values

JSON_PROPERTY_ALGORITHM

public static final String JSON_PROPERTY_ALGORITHM

See Also:

Constant Field Values

JSON_PROPERTY_EXPIRES_IN

public static final String JSON_PROPERTY_EXPIRES_IN

See Also:

Constant Field Values

JSON_PROPERTY_HEADER

public static final String JSON_PROPERTY_HEADER

See Also:

Constant Field Values

JSON_PROPERTY_PAYLOAD

public static final String JSON_PROPERTY_PAYLOAD

See Also:

Constant Field Values

JSON_PROPERTY_SECRET

public static final String JSON_PROPERTY_SECRET

See Also:

Constant Field Values

JSON_PROPERTY_TOKEN_PREFIX

public static final String JSON_PROPERTY_TOKEN_PREFIX

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

SyntheticsBasicAuthJWT

public SyntheticsBasicAuthJWT()

SyntheticsBasicAuthJWT

public SyntheticsBasicAuthJWT(SyntheticsBasicAuthJWTAlgorithm algorithm,
                              String payload,
                              String secret,
                              SyntheticsBasicAuthJWTType type)

Method Detail

addClaims

public SyntheticsBasicAuthJWT addClaims(SyntheticsBasicAuthJWTAddClaims addClaims)

getAddClaims

@Nullable
public SyntheticsBasicAuthJWTAddClaims getAddClaims()

Standard JWT claims to automatically inject.

Returns:

addClaims

setAddClaims

public void setAddClaims(SyntheticsBasicAuthJWTAddClaims addClaims)

algorithm

public SyntheticsBasicAuthJWT algorithm(SyntheticsBasicAuthJWTAlgorithm algorithm)

getAlgorithm

public SyntheticsBasicAuthJWTAlgorithm getAlgorithm()

Algorithm to use for the JWT authentication.

Returns:

algorithm

setAlgorithm

public void setAlgorithm(SyntheticsBasicAuthJWTAlgorithm algorithm)

expiresIn

public SyntheticsBasicAuthJWT expiresIn(Long expiresIn)

getExpiresIn

@Nullable
public Long getExpiresIn()

Token time-to-live in seconds. minimum: 1

Returns:

expiresIn

setExpiresIn

public void setExpiresIn(Long expiresIn)

header

public SyntheticsBasicAuthJWT header(String header)

getHeader

@Nullable
public String getHeader()

Custom JWT header as a JSON string.

Returns:

header

setHeader

public void setHeader(String header)

payload

public SyntheticsBasicAuthJWT payload(String payload)

getPayload

public String getPayload()

JWT claims as a JSON string.

Returns:

payload

setPayload

public void setPayload(String payload)

secret

public SyntheticsBasicAuthJWT secret(String secret)

getSecret

public String getSecret()

Signing key for the JWT authentication. Use the shared secret for HS256 or the private key (PEM format) for RS256 and ES256.

Returns:

secret

setSecret

public void setSecret(String secret)

tokenPrefix

public SyntheticsBasicAuthJWT tokenPrefix(String tokenPrefix)

getTokenPrefix

@Nullable
public String getTokenPrefix()

Prefix added before the token in the Authorization header. Defaults to Bearer.

Returns:

tokenPrefix

setTokenPrefix

public void setTokenPrefix(String tokenPrefix)

type

public SyntheticsBasicAuthJWT type(SyntheticsBasicAuthJWTType type)

getType

public SyntheticsBasicAuthJWTType getType()

The type of authentication to use when performing the test.

Returns:

type

setType

public void setType(SyntheticsBasicAuthJWTType type)

putAdditionalProperty

public SyntheticsBasicAuthJWT putAdditionalProperty(String key,
                                                    Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

SyntheticsBasicAuthJWT

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this SyntheticsBasicAuthJWT object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object