Package software.amazon.awssdk.services.managedblockchain.model

Class CreateProposalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.managedblockchain.model.ManagedBlockchainRequest

software.amazon.awssdk.services.managedblockchain.model.CreateProposalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProposalRequest.Builder,CreateProposalRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateProposalRequest
extends ManagedBlockchainRequest
implements ToCopyableBuilder<CreateProposalRequest.Builder,CreateProposalRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateProposalRequest.Builder

Method Summary

Modifier and Type	Method	Description
ProposalActions	actions()	The type of actions proposed, such as inviting a member or removing a member.
static CreateProposalRequest.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation.
String	description()	A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	memberId()	The unique identifier of the member that is creating the proposal.
String	networkId()	The unique identifier of the network for which the proposal is made.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProposalRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tags to assign to the proposal.
CreateProposalRequest.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

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.

networkId

public final String networkId()

The unique identifier of the network for which the proposal is made.

Returns:

The unique identifier of the network for which the proposal is made.

memberId

public final String memberId()

The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single Amazon Web Services account.

Returns:

The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single Amazon Web Services account.

actions

public final ProposalActions actions()

The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

Returns:

The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

description

public final String description()

A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

Returns:

A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

Tags to assign to the proposal.

Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

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 hasTags() method.

Returns:

Tags to assign to the proposal.

Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

toBuilder

public CreateProposalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProposalRequest.Builder,CreateProposalRequest>

Specified by:

toBuilder in class ManagedBlockchainRequest

builder

public static CreateProposalRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProposalRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo