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

Interface GetCampaignResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetCampaignResponse.Builder,GetCampaignResponse>, IoTFleetWiseResponse.Builder, SdkBuilder<GetCampaignResponse.Builder,GetCampaignResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetCampaignResponse
public static interface GetCampaignResponse.Builder extends IoTFleetWiseResponse.Builder, SdkPojo, CopyableBuilder<GetCampaignResponse.Builder,GetCampaignResponse>

  • Method Details

    • name

      GetCampaignResponse.Builder name(String name)

      The name of the campaign.

      Parameters:
      name - The name of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      GetCampaignResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the campaign.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

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

    • signalCatalogArn

      GetCampaignResponse.Builder signalCatalogArn(String signalCatalogArn)

      The ARN of a signal catalog.

      Parameters:
      signalCatalogArn - The ARN of a signal catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetArn

      GetCampaignResponse.Builder targetArn(String targetArn)

      The ARN of the vehicle or the fleet targeted by the campaign.

      Parameters:
      targetArn - The ARN of the vehicle or the fleet targeted by the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetCampaignResponse.Builder status(String status)

      The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

      Parameters:
      status - The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetCampaignResponse.Builder status(CampaignStatus status)

      The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

      Parameters:
      status - The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTime

      GetCampaignResponse.Builder startTime(Instant startTime)

      The time, in milliseconds, to deliver a campaign after it was approved.

      Parameters:
      startTime - The time, in milliseconds, to deliver a campaign after it was approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiryTime

      GetCampaignResponse.Builder expiryTime(Instant expiryTime)

      The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

      Parameters:
      expiryTime - The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • postTriggerCollectionDuration

      GetCampaignResponse.Builder postTriggerCollectionDuration(Long postTriggerCollectionDuration)

      How long (in seconds) to collect raw data after a triggering event initiates the collection.

      Parameters:
      postTriggerCollectionDuration - How long (in seconds) to collect raw data after a triggering event initiates the collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diagnosticsMode

      GetCampaignResponse.Builder diagnosticsMode(String diagnosticsMode)

      Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

      Parameters:
      diagnosticsMode - Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • diagnosticsMode

      GetCampaignResponse.Builder diagnosticsMode(DiagnosticsMode diagnosticsMode)

      Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

      Parameters:
      diagnosticsMode - Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spoolingMode

      GetCampaignResponse.Builder spoolingMode(String spoolingMode)

      Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

      Parameters:
      spoolingMode - Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spoolingMode

      GetCampaignResponse.Builder spoolingMode(SpoolingMode spoolingMode)

      Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

      Parameters:
      spoolingMode - Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compression

      GetCampaignResponse.Builder compression(String compression)

      Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

      Parameters:
      compression - Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compression

      GetCampaignResponse.Builder compression(Compression compression)

      Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

      Parameters:
      compression - Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • priority

      GetCampaignResponse.Builder priority(Integer priority)

      A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.

      Parameters:
      priority - A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalsToCollect

      GetCampaignResponse.Builder signalsToCollect(Collection<SignalInformation> signalsToCollect)

      Information about a list of signals to collect data on.

      Parameters:
      signalsToCollect - Information about a list of signals to collect data on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalsToCollect

      GetCampaignResponse.Builder signalsToCollect(SignalInformation... signalsToCollect)

      Information about a list of signals to collect data on.

      Parameters:
      signalsToCollect - Information about a list of signals to collect data on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalsToCollect

      GetCampaignResponse.Builder signalsToCollect(Consumer<SignalInformation.Builder>... signalsToCollect)

      Information about a list of signals to collect data on.

      This is a convenience method that creates an instance of the SignalInformation.Builder avoiding the need to create one manually via SignalInformation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to signalsToCollect(List<SignalInformation>).

      Parameters:
      signalsToCollect - a consumer that will call methods on SignalInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • collectionScheme

      GetCampaignResponse.Builder collectionScheme(CollectionScheme collectionScheme)

      Information about the data collection scheme associated with the campaign.

      Parameters:
      collectionScheme - Information about the data collection scheme associated with the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collectionScheme

      default GetCampaignResponse.Builder collectionScheme(Consumer<CollectionScheme.Builder> collectionScheme)

      Information about the data collection scheme associated with the campaign.

      This is a convenience method that creates an instance of the CollectionScheme.Builder avoiding the need to create one manually via CollectionScheme.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to collectionScheme(CollectionScheme).

      Parameters:
      collectionScheme - a consumer that will call methods on CollectionScheme.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataExtraDimensions

      GetCampaignResponse.Builder dataExtraDimensions(Collection<String> dataExtraDimensions)

      A list of vehicle attributes associated with the campaign.

      Parameters:
      dataExtraDimensions - A list of vehicle attributes associated with the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataExtraDimensions

      GetCampaignResponse.Builder dataExtraDimensions(String... dataExtraDimensions)

      A list of vehicle attributes associated with the campaign.

      Parameters:
      dataExtraDimensions - A list of vehicle attributes associated with the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      GetCampaignResponse.Builder creationTime(Instant creationTime)

      The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

      Parameters:
      creationTime - The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModificationTime

      GetCampaignResponse.Builder lastModificationTime(Instant lastModificationTime)

      The last time the campaign was modified.

      Parameters:
      lastModificationTime - The last time the campaign was modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataDestinationConfigs

      GetCampaignResponse.Builder dataDestinationConfigs(Collection<DataDestinationConfig> dataDestinationConfigs)

      The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

      Parameters:
      dataDestinationConfigs - The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

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

    • dataDestinationConfigs

      GetCampaignResponse.Builder dataDestinationConfigs(DataDestinationConfig... dataDestinationConfigs)

      The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

      Parameters:
      dataDestinationConfigs - The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

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

    • dataDestinationConfigs

      GetCampaignResponse.Builder dataDestinationConfigs(Consumer<DataDestinationConfig.Builder>... dataDestinationConfigs)

      The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

      Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

      You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

      This is a convenience method that creates an instance of the DataDestinationConfig.Builder avoiding the need to create one manually via DataDestinationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataDestinationConfigs(List<DataDestinationConfig>).

      Parameters:
      dataDestinationConfigs - a consumer that will call methods on DataDestinationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: