com.google.ads.googleads.v17.resources.ExperimentArmOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/experiment_arm.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface ExperimentArmOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.ExperimentArm)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the experiment arm.
   * Experiment arm resource names have the form:
   *
   * `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the experiment arm.
   * Experiment arm resource names have the form:
   *
   * `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Immutable. The experiment to which the ExperimentArm belongs.
   * 
   *
   * string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The experiment.
   */
  java.lang.String getExperiment();
  /**
   *    * Immutable. The experiment to which the ExperimentArm belongs.
   * 
   *
   * string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for experiment.
   */
  com.google.protobuf.ByteString
      getExperimentBytes();

  /**
   *    * Required. The name of the experiment arm. It must have a minimum length of
   * 1 and maximum length of 1024. It must be unique under an experiment.
   * 
   *
   * string name = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Required. The name of the experiment arm. It must have a minimum length of
   * 1 and maximum length of 1024. It must be unique under an experiment.
   * 
   *
   * string name = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Whether this arm is a control arm. A control arm is the arm against
   * which the other arms are compared.
   * 
   *
   * bool control = 4;
   * @return The control.
   */
  boolean getControl();

  /**
   *    * Traffic split of the trial arm. The value should be between 1 and 100
   * and must total 100 between the two trial arms.
   * 
   *
   * int64 traffic_split = 5;
   * @return The trafficSplit.
   */
  long getTrafficSplit();

  /**
   *    * List of campaigns in the trial arm. The max length is one.
   * 
   *
   * repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
   * @return A list containing the campaigns.
   */
  java.util.List
      getCampaignsList();
  /**
   *    * List of campaigns in the trial arm. The max length is one.
   * 
   *
   * repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
   * @return The count of campaigns.
   */
  int getCampaignsCount();
  /**
   *    * List of campaigns in the trial arm. The max length is one.
   * 
   *
   * repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The campaigns at the given index.
   */
  java.lang.String getCampaigns(int index);
  /**
   *    * List of campaigns in the trial arm. The max length is one.
   * 
   *
   * repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the campaigns at the given index.
   */
  com.google.protobuf.ByteString
      getCampaignsBytes(int index);

  /**
   *    * Output only. The in design campaigns in the treatment experiment arm.
   * 
   *
   * repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return A list containing the inDesignCampaigns.
   */
  java.util.List
      getInDesignCampaignsList();
  /**
   *    * Output only. The in design campaigns in the treatment experiment arm.
   * 
   *
   * repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The count of inDesignCampaigns.
   */
  int getInDesignCampaignsCount();
  /**
   *    * Output only. The in design campaigns in the treatment experiment arm.
   * 
   *
   * repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The inDesignCampaigns at the given index.
   */
  java.lang.String getInDesignCampaigns(int index);
  /**
   *    * Output only. The in design campaigns in the treatment experiment arm.
   * 
   *
   * repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the inDesignCampaigns at the given index.
   */
  com.google.protobuf.ByteString
      getInDesignCampaignsBytes(int index);
}