Package software.amazon.smithy.aws.traits

Class ServiceTrait.Builder

java.lang.Object

software.amazon.smithy.model.traits.AbstractTraitBuilder<ServiceTrait,ServiceTrait.Builder>

software.amazon.smithy.aws.traits.ServiceTrait.Builder

All Implemented Interfaces:

SmithyBuilder<ServiceTrait>

Enclosing class:

ServiceTrait

public static final class ServiceTrait.Builder
extends AbstractTraitBuilder<ServiceTrait,ServiceTrait.Builder>

Builder for ServiceTrait.

Method Summary

Modifier and Type	Method	Description
ServiceTrait.Builder	abbreviation(java.lang.String abbreviation)	Deprecated.
ServiceTrait.Builder	arnNamespace(java.lang.String arnNamespace)	Set the ARN service namespace of the service.
ServiceTrait	build()	Creates an immutable object that is created from the properties that have been set on the builder.
ServiceTrait	build(ShapeId target)
ServiceTrait.Builder	cloudFormationName(java.lang.String cloudFormationName)	Sets the AWS CloudFormation resource type service name.
ServiceTrait.Builder	cloudTrailEventSource(java.lang.String cloudTrailEventSource)	Set the CloudTrail event source name of the service.
ServiceTrait.Builder	docId(java.lang.String docId)	Set the documentation identifier for the service.
ServiceTrait.Builder	endpointPrefix(java.lang.String endpointPrefix)	Set the endpoint prefix used to construct client endpoints.
ServiceTrait.Builder	sdkId(java.lang.String sdkId)	Set the SDK service ID trait used to control client class names.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTraitBuilder

getSourceLocation, sourceLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

public ServiceTrait build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Returns:

an instance of T

build

public ServiceTrait build(ShapeId target)

cloudFormationName

public ServiceTrait.Builder cloudFormationName(java.lang.String cloudFormationName)

Sets the AWS CloudFormation resource type service name.

Must match the following regex ^[a-z0-9.\-]{1,63}$

Parameters:

cloudFormationName - AWS CloudFormation resource type service name.

Returns:

Returns the builder.

arnNamespace

public ServiceTrait.Builder arnNamespace(java.lang.String arnNamespace)

Set the ARN service namespace of the service.

Must match the following regex: ^[A-Z][A-Za-z0-9]+$

Parameters:

arnNamespace - ARN service namespace to set.

Returns:

Returns the builder.

sdkId

public ServiceTrait.Builder sdkId(java.lang.String sdkId)

Set the SDK service ID trait used to control client class names.

Must match the following regex: ^[a-zA-Z][a-zA-Z0-9]*( [a-zA-Z0-9]+)*$

Parameters:

sdkId - SDK service ID to set.

Returns:

Returns the builder.

cloudTrailEventSource

public ServiceTrait.Builder cloudTrailEventSource(java.lang.String cloudTrailEventSource)

Set the CloudTrail event source name of the service.

Parameters:

cloudTrailEventSource - CloudTrail event source name of the service.

Returns:

Returns the builder.

docId

public ServiceTrait.Builder docId(java.lang.String docId)

Set the documentation identifier for the service.

Parameters:

docId - documentation identifier for the service.

Returns:

Returns the builder.

endpointPrefix

public ServiceTrait.Builder endpointPrefix(java.lang.String endpointPrefix)

Set the endpoint prefix used to construct client endpoints.

Parameters:

endpointPrefix - The endpoint prefix of the service.

Returns:

Returns the builder.

abbreviation

@Deprecated
public ServiceTrait.Builder abbreviation(java.lang.String abbreviation)

Deprecated.