com.amazonaws.services.iotfleetwise.model

Class UpdateCampaignRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotfleetwise.model.UpdateCampaignRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateCampaignRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateCampaignRequest()

Method Summary

Modifier and Type	Method and Description
UpdateCampaignRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAction() Specifies how to update a campaign.
List<String>	getDataExtraDimensions() A list of vehicle attributes to associate with a signal.
String	getDescription() The description of the campaign.
String	getName() The name of the campaign to update.
int	hashCode()
void	setAction(String action) Specifies how to update a campaign.
void	setDataExtraDimensions(Collection<String> dataExtraDimensions) A list of vehicle attributes to associate with a signal.
void	setDescription(String description) The description of the campaign.
void	setName(String name) The name of the campaign to update.
String	toString() Returns a string representation of this object.
UpdateCampaignRequest	withAction(String action) Specifies how to update a campaign.
UpdateCampaignRequest	withAction(UpdateCampaignAction action) Specifies how to update a campaign.
UpdateCampaignRequest	withDataExtraDimensions(Collection<String> dataExtraDimensions) A list of vehicle attributes to associate with a signal.
UpdateCampaignRequest	withDataExtraDimensions(String... dataExtraDimensions) A list of vehicle attributes to associate with a signal.
UpdateCampaignRequest	withDescription(String description) The description of the campaign.
UpdateCampaignRequest	withName(String name) The name of the campaign to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateCampaignRequest

public UpdateCampaignRequest()

Method Detail

setName

public void setName(String name)

The name of the campaign to update.

Parameters:

name - The name of the campaign to update.

getName

public String getName()

The name of the campaign to update.

Returns:

The name of the campaign to update.

withName

public UpdateCampaignRequest withName(String name)

The name of the campaign to update.

Parameters:

name - The name of the campaign to update.

Returns:

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

setDescription

public void setDescription(String description)

The description of the campaign.

Parameters:

description - The description of the campaign.

getDescription

public String getDescription()

The description of the campaign.

Returns:

The description of the campaign.

withDescription

public UpdateCampaignRequest withDescription(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.

getDataExtraDimensions

public List<String> getDataExtraDimensions()

A list of vehicle attributes to associate with a signal.

Default: An empty array

Returns:

A list of vehicle attributes to associate with a signal.

Default: An empty array

setDataExtraDimensions

public void setDataExtraDimensions(Collection<String> dataExtraDimensions)

A list of vehicle attributes to associate with a signal.

Default: An empty array

Parameters:

dataExtraDimensions - A list of vehicle attributes to associate with a signal.

Default: An empty array

withDataExtraDimensions

public UpdateCampaignRequest withDataExtraDimensions(String... dataExtraDimensions)

A list of vehicle attributes to associate with a signal.

Default: An empty array

NOTE: This method appends the values to the existing list (if any). Use setDataExtraDimensions(java.util.Collection) or withDataExtraDimensions(java.util.Collection) if you want to override the existing values.

Parameters:

dataExtraDimensions - A list of vehicle attributes to associate with a signal.

Default: An empty array

Returns:

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

withDataExtraDimensions

public UpdateCampaignRequest withDataExtraDimensions(Collection<String> dataExtraDimensions)

A list of vehicle attributes to associate with a signal.

Default: An empty array

Parameters:

dataExtraDimensions - A list of vehicle attributes to associate with a signal.

Default: An empty array

Returns:

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

setAction

public void setAction(String 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.

Parameters:

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.

See Also:

UpdateCampaignAction

getAction

public String getAction()

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.

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

withAction

public UpdateCampaignRequest withAction(String 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.

Parameters:

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.

Returns:

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

See Also:

UpdateCampaignAction

withAction

public UpdateCampaignRequest withAction(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.

Parameters:

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.

Returns:

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

See Also:

UpdateCampaignAction

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateCampaignRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()