com.amazonaws.services.managedgrafana.model

Class CreateWorkspaceApiKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.managedgrafana.model.CreateWorkspaceApiKeyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkspaceApiKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWorkspaceApiKeyRequest()

Method Summary

Modifier and Type	Method and Description
CreateWorkspaceApiKeyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getKeyName() Specifies the name of the key.
String	getKeyRole() Specifies the permission level of the key.
Integer	getSecondsToLive() Specifies the time in seconds until the key expires.
String	getWorkspaceId() The ID of the workspace to create an API key.
int	hashCode()
void	setKeyName(String keyName) Specifies the name of the key.
void	setKeyRole(String keyRole) Specifies the permission level of the key.
void	setSecondsToLive(Integer secondsToLive) Specifies the time in seconds until the key expires.
void	setWorkspaceId(String workspaceId) The ID of the workspace to create an API key.
String	toString() Returns a string representation of this object.
CreateWorkspaceApiKeyRequest	withKeyName(String keyName) Specifies the name of the key.
CreateWorkspaceApiKeyRequest	withKeyRole(String keyRole) Specifies the permission level of the key.
CreateWorkspaceApiKeyRequest	withSecondsToLive(Integer secondsToLive) Specifies the time in seconds until the key expires.
CreateWorkspaceApiKeyRequest	withWorkspaceId(String workspaceId) The ID of the workspace to create an API key.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWorkspaceApiKeyRequest

public CreateWorkspaceApiKeyRequest()

Method Detail

setKeyName

public void setKeyName(String keyName)

Specifies the name of the key. Keynames must be unique to the workspace.

Parameters:

keyName - Specifies the name of the key. Keynames must be unique to the workspace.

getKeyName

public String getKeyName()

Specifies the name of the key. Keynames must be unique to the workspace.

Returns:

Specifies the name of the key. Keynames must be unique to the workspace.

withKeyName

public CreateWorkspaceApiKeyRequest withKeyName(String keyName)

Specifies the name of the key. Keynames must be unique to the workspace.

Parameters:

keyName - Specifies the name of the key. Keynames must be unique to the workspace.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKeyRole

public void setKeyRole(String keyRole)

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

Parameters:

keyRole - Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

getKeyRole

public String getKeyRole()

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

Returns:

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

withKeyRole

public CreateWorkspaceApiKeyRequest withKeyRole(String keyRole)

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

Parameters:

keyRole - Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecondsToLive

public void setSecondsToLive(Integer secondsToLive)

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Parameters:

secondsToLive - Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

getSecondsToLive

public Integer getSecondsToLive()

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Returns:

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

withSecondsToLive

public CreateWorkspaceApiKeyRequest withSecondsToLive(Integer secondsToLive)

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Parameters:

secondsToLive - Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Returns:

Returns a reference to this object so that method calls can be chained together.

setWorkspaceId

public void setWorkspaceId(String workspaceId)

The ID of the workspace to create an API key.

Parameters:

workspaceId - The ID of the workspace to create an API key.

getWorkspaceId

public String getWorkspaceId()

The ID of the workspace to create an API key.

Returns:

The ID of the workspace to create an API key.

withWorkspaceId

public CreateWorkspaceApiKeyRequest withWorkspaceId(String workspaceId)

The ID of the workspace to create an API key.

Parameters:

workspaceId - The ID of the workspace to create an API key.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateWorkspaceApiKeyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()