CampaignSummary (AWS Java SDK :: Services :: Io T Fleet Wise 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.iotfleetwise.model.CampaignSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CampaignSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>
```
Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CampaignSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CampaignSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of a campaign.
`static CampaignSummary.Builder`	`builder()`
`Instant`	`creationTime()` The time the campaign was created.
`String`	`description()` The description of the campaign.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastModificationTime()` The last time the campaign was modified.
`String`	`name()` The name of a campaign.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CampaignSummary.Builder>`	`serializableBuilderClass()`
`String`	`signalCatalogArn()` The ARN of the signal catalog associated with the campaign.
`CampaignStatus`	`status()` The state of a campaign.
`String`	`statusAsString()` The state of a campaign.
`String`	`targetArn()` The ARN of a vehicle or fleet to which the campaign is deployed.
`CampaignSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of a campaign.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a campaign.
  - name
```
public final String name()
```
    The name of a campaign.
    
    Returns:
    
    The name of a campaign.
  - description
```
public final String description()
```
    The description of the campaign.
    
    Returns:
    
    The description of the campaign.
  - signalCatalogArn
```
public final String signalCatalogArn()
```
    The ARN of the signal catalog associated with the campaign.
    
    Returns:
    
    The ARN of the signal catalog associated with the campaign.
  - targetArn
```
public final String targetArn()
```
    The ARN of a vehicle or fleet to which the campaign is deployed.
    
    Returns:
    
    The ARN of a vehicle or fleet to which the campaign is deployed.
  - status
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, status will return CampaignStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    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.
    See Also:
    
    CampaignStatus
  - statusAsString
```
public final String statusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, status will return CampaignStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    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.
    See Also:
    
    CampaignStatus
  - creationTime
```
public final Instant creationTime()
```
    The time the campaign was created.
    
    Returns:
    
    The time the campaign was created.
  - lastModificationTime
```
public final Instant lastModificationTime()
```
    The last time the campaign was modified.
    
    Returns:
    
    The last time the campaign was modified.
  - toBuilder
```
public CampaignSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>
  - builder
```
public static CampaignSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CampaignSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CampaignSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

description

signalCatalogArn

targetArn

status

statusAsString

creationTime

lastModificationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields