DraftAsyncErrorField.java

// Copyright 2017 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.api.ads.adwords.lib.selectorfields.v201702.cm;

import com.google.api.ads.adwords.lib.selectorfields.EntityField;
import com.google.api.ads.adwords.lib.selectorfields.Filterable;

/**
 * A {@code Enum} to facilitate the selection of fields for {@code DraftAsyncError}.
 */
public enum DraftAsyncErrorField implements EntityField {

  // Fields constants definitions

  /**
   * The error that occurred while promoting the draft.
   */
  AsyncError(false),

  /**
   * The error occurred during promotion while updating this AdGroup or an entity in this AdGroup.
   */
  BaseAdGroupId(false),

  /**
   * The error occurred during promotion while updating this Campaign or an entity in this Campaign.
   * This field can only be used with Predicate Operators EQUALS and IN.
   * When using a Predicate with this field, also include a Predicate for the field DraftId.
   */
  @Filterable
  BaseCampaignId(true),

  /**
   * The draft AdGroup that was attempted to be promoted.
   */
  DraftAdGroupId(false),

  /**
   * The draft Campaign that was attempted to be promoted.
   */
  DraftCampaignId(false),

  /**
   * The draft that was attempted to be promoted.
   * This field can only be used with Predicate Operators EQUALS and IN.
   * When using a Predicate with this field, also include a Predicate for the field BaseCampaignId.
   */
  @Filterable
  DraftId(true),

  ;

  private final boolean isFilterable;

  private DraftAsyncErrorField(boolean isFilterable) {
    this.isFilterable = isFilterable;
  }

  @Override
  public boolean isFilterable() {
    return this.isFilterable;
  }

}