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

Class UpdateCampaignRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest

software.amazon.awssdk.services.iotfleetwise.model.UpdateCampaignRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateCampaignRequest.Builder

Method Summary

Modifier and Type	Method	Description
UpdateCampaignAction	action()	Specifies how to update a campaign.
String	actionAsString()	Specifies how to update a campaign.
static UpdateCampaignRequest.Builder	builder()
List<String>	dataExtraDimensions()	A list of vehicle attributes to associate with a signal.
String	description()	The description of the campaign.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataExtraDimensions()	For responses, this returns true if the service returned a value for the DataExtraDimensions property.
int	hashCode()
String	name()	The name of the campaign to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCampaignRequest.Builder>	serializableBuilderClass()
UpdateCampaignRequest.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

name

public final String name()

The name of the campaign to update.

Returns:

The name of the campaign to update.

description

public final String description()

The description of the campaign.

Returns:

The description of the campaign.

hasDataExtraDimensions

public final boolean hasDataExtraDimensions()

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

dataExtraDimensions

public final List<String> dataExtraDimensions()

A list of vehicle attributes to associate with a signal.

Default: An empty array

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

Returns:

A list of vehicle attributes to associate with a signal.

Default: An empty array

action

public final UpdateCampaignAction action()

Specifies how to update a campaign. The action can be one of the following:

• APPROVE - To approve delivering a data collection scheme to vehicles.

• SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

• RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

• UPDATE - To update a campaign.

If the service returns an enum value that is not available in the current SDK version, action will return UpdateCampaignAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies how to update a campaign. The action can be one of the following:

• APPROVE - To approve delivering a data collection scheme to vehicles.

• SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

• RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

• UPDATE - To update a campaign.

See Also:

UpdateCampaignAction

actionAsString

public final String actionAsString()

Specifies how to update a campaign. The action can be one of the following:

• APPROVE - To approve delivering a data collection scheme to vehicles.

• SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

• RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

• UPDATE - To update a campaign.

If the service returns an enum value that is not available in the current SDK version, action will return UpdateCampaignAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies how to update a campaign. The action can be one of the following:

• APPROVE - To approve delivering a data collection scheme to vehicles.

• SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

• RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

• UPDATE - To update a campaign.

See Also:

UpdateCampaignAction

toBuilder

public UpdateCampaignRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>

Specified by:

toBuilder in class IoTFleetWiseRequest

builder

public static UpdateCampaignRequest.Builder builder()

serializableBuilderClass

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