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>

  • Method Details

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

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

    • toBuilder

      public UpdateCampaignResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateCampaignResponse.Builder,UpdateCampaignResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.