software.amazon.awssdk.services.iotfleetwise.model

Interface CampaignSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CampaignSummary.Builder,CampaignSummary>, SdkBuilder<CampaignSummary.Builder,CampaignSummary>, SdkPojo

Enclosing class:

CampaignSummary

public static interface CampaignSummary.Builder
extends SdkPojo, CopyableBuilder<CampaignSummary.Builder,CampaignSummary>

Method Summary

Modifier and Type	Method and Description
CampaignSummary.Builder	arn(String arn) The Amazon Resource Name (ARN) of a campaign.
CampaignSummary.Builder	creationTime(Instant creationTime) The time the campaign was created.
CampaignSummary.Builder	description(String description) The description of the campaign.
CampaignSummary.Builder	lastModificationTime(Instant lastModificationTime) The last time the campaign was modified.
CampaignSummary.Builder	name(String name) The name of a campaign.
CampaignSummary.Builder	signalCatalogArn(String signalCatalogArn) The ARN of the signal catalog associated with the campaign.
CampaignSummary.Builder	status(CampaignStatus status) The state of a campaign.
CampaignSummary.Builder	status(String status) The state of a campaign.
CampaignSummary.Builder	targetArn(String targetArn) The ARN of a vehicle or fleet to which the campaign is deployed.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

arn

CampaignSummary.Builder arn(String arn)

The Amazon Resource Name (ARN) of a campaign.

Parameters:

arn - The Amazon Resource Name (ARN) of a campaign.

Returns:

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

name

CampaignSummary.Builder name(String name)

The name of a campaign.

Parameters:

name - The name of a campaign.

Returns:

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

description

CampaignSummary.Builder description(String description)

The description of the campaign.

Parameters:

description - The description of the campaign.

Returns:

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

signalCatalogArn

CampaignSummary.Builder signalCatalogArn(String signalCatalogArn)

The ARN of the signal catalog associated with the campaign.

Parameters:

signalCatalogArn - The ARN of the signal catalog associated with the campaign.

Returns:

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

targetArn

CampaignSummary.Builder targetArn(String targetArn)

The ARN of a vehicle or fleet to which the campaign is deployed.

Parameters:

targetArn - The ARN of a vehicle or fleet to which the campaign is deployed.

Returns:

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

status

CampaignSummary.Builder status(String status)

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

Parameters:

status - The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

Returns:

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

See Also:

CampaignStatus, CampaignStatus

status

CampaignSummary.Builder status(CampaignStatus status)

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

Parameters:

status - The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

Returns:

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

See Also:

CampaignStatus, CampaignStatus

creationTime

CampaignSummary.Builder creationTime(Instant creationTime)

The time the campaign was created.

Parameters:

creationTime - The time the campaign was created.

Returns:

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

lastModificationTime

CampaignSummary.Builder lastModificationTime(Instant lastModificationTime)

The last time the campaign was modified.

Parameters:

lastModificationTime - The last time the campaign was modified.

Returns:

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