Interface UpdateCampaignRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>, IoTFleetWiseRequest.Builder, SdkBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateCampaignRequest
@Mutable @NotThreadSafe public static interface UpdateCampaignRequest.Builder extends IoTFleetWiseRequest.Builder, SdkPojo, CopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>

  • Method Details

    • name

      UpdateCampaignRequest.Builder name(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.

    • description

      UpdateCampaignRequest.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.

    • dataExtraDimensions

      UpdateCampaignRequest.Builder dataExtraDimensions(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.

    • dataExtraDimensions

      UpdateCampaignRequest.Builder dataExtraDimensions(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.

    • action

      UpdateCampaignRequest.Builder action(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:

    • action

      UpdateCampaignRequest.Builder action(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:

    • overrideConfiguration

      UpdateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateCampaignRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.