Package software.amazon.awssdk.services.iotfleetwise.model

Class UpdateCampaignResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse

software.amazon.awssdk.services.iotfleetwise.model.UpdateCampaignResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCampaignResponse.Builder,UpdateCampaignResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateCampaignResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the campaign.
static UpdateCampaignResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the updated campaign.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCampaignResponse.Builder>	serializableBuilderClass()
CampaignStatus	status()	The state of a campaign.
String	statusAsString()	The state of a campaign.
UpdateCampaignResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 the campaign.

Returns:

The Amazon Resource Name (ARN) of the campaign.

name

public final String name()

The name of the updated campaign.

Returns:

The name of the updated campaign.

status

public final CampaignStatus status()

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

• 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:

• 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:

• 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:

• 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

toBuilder

public UpdateCampaignResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateCampaignResponse.Builder,UpdateCampaignResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static UpdateCampaignResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo