software.amazon.awssdk.services.codeguruprofiler.model

Class PutPermissionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerRequest

software.amazon.awssdk.services.codeguruprofiler.model.PutPermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutPermissionRequest
extends CodeGuruProfilerRequest
implements ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>

The structure representing the putPermissionRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutPermissionRequest.Builder

Method Summary

Modifier and Type	Method and Description
ActionGroup	actionGroup() Specifies an action group that contains permissions to add to a profiling group resource.
String	actionGroupAsString() Specifies an action group that contains permissions to add to a profiling group resource.
static PutPermissionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPrincipals() For responses, this returns true if the service returned a value for the Principals property.
List<String>	principals() A list ARNs for the roles and users you want to grant access to the profiling group.
String	profilingGroupName() The name of the profiling group to grant access to.
String	revisionId() A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group.
List<SdkField<?>>	sdkFields()
static Class<? extends PutPermissionRequest.Builder>	serializableBuilderClass()
PutPermissionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

actionGroup

public final ActionGroup actionGroup()

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

If the service returns an enum value that is not available in the current SDK version, actionGroup will return ActionGroup.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionGroupAsString().

Returns:

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

See Also:

ActionGroup

actionGroupAsString

public final String actionGroupAsString()

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

If the service returns an enum value that is not available in the current SDK version, actionGroup will return ActionGroup.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionGroupAsString().

Returns:

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

See Also:

ActionGroup

hasPrincipals

public final boolean hasPrincipals()

For responses, this returns true if the service returned a value for the Principals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

principals

public final List<String> principals()

A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrincipals() method.

Returns:

A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

profilingGroupName

public final String profilingGroupName()

The name of the profiling group to grant access to.

Returns:

The name of the profiling group to grant access to.

revisionId

public final String revisionId()

A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

Returns:

A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

toBuilder

public PutPermissionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>

Specified by:

toBuilder in class CodeGuruProfilerRequest

builder

public static PutPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutPermissionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo