Class CreateWorkspaceApiKeyRequest
java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.grafana.model.GrafanaRequest
software.amazon.awssdk.services.grafana.model.CreateWorkspaceApiKeyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,
CreateWorkspaceApiKeyRequest>
@Generated("software.amazon.awssdk:codegen")
public final class CreateWorkspaceApiKeyRequest
extends GrafanaRequest
implements ToCopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,CreateWorkspaceApiKeyRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
keyName()
Specifies the name of the key.final String
keyRole()
Specifies the permission level of the key.final Integer
Specifies the time in seconds until the key expires.static Class
<? extends CreateWorkspaceApiKeyRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the workspace to create an API key.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyName
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.
-
keyRole
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
-
secondsToLive
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.
-
workspaceId
The ID of the workspace to create an API key.
- Returns:
- The ID of the workspace to create an API key.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateWorkspaceApiKeyRequest.Builder,
CreateWorkspaceApiKeyRequest> - Specified by:
toBuilder
in classGrafanaRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-