com.google.ads.googleads.v17.resources.KeywordPlanName 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!
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *      https://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.ads.googleads.v17.resources;

import com.google.api.pathtemplate.PathTemplate;
import com.google.api.resourcenames.ResourceName;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@Generated("by gapic-generator-java")
public class KeywordPlanName implements ResourceName {
  private static final PathTemplate CUSTOMER_ID_KEYWORD_PLAN_ID =
      PathTemplate.createWithoutUrlEncoding(
          "customers/{customer_id}/keywordPlans/{keyword_plan_id}");
  private volatile Map fieldValuesMap;
  private final String customerId;
  private final String keywordPlanId;

  @Deprecated
  protected KeywordPlanName() {
    customerId = null;
    keywordPlanId = null;
  }

  private KeywordPlanName(Builder builder) {
    customerId = Preconditions.checkNotNull(builder.getCustomerId());
    keywordPlanId = Preconditions.checkNotNull(builder.getKeywordPlanId());
  }

  public String getCustomerId() {
    return customerId;
  }

  public String getKeywordPlanId() {
    return keywordPlanId;
  }

  public static Builder newBuilder() {
    return new Builder();
  }

  public Builder toBuilder() {
    return new Builder(this);
  }

  public static KeywordPlanName of(String customerId, String keywordPlanId) {
    return newBuilder().setCustomerId(customerId).setKeywordPlanId(keywordPlanId).build();
  }

  public static String format(String customerId, String keywordPlanId) {
    return newBuilder()
        .setCustomerId(customerId)
        .setKeywordPlanId(keywordPlanId)
        .build()
        .toString();
  }

  public static KeywordPlanName parse(String formattedString) {
    if (formattedString.isEmpty()) {
      return null;
    }
    Map matchMap =
        CUSTOMER_ID_KEYWORD_PLAN_ID.validatedMatch(
            formattedString, "KeywordPlanName.parse: formattedString not in valid format");
    return of(matchMap.get("customer_id"), matchMap.get("keyword_plan_id"));
  }

  public static List parseList(List formattedStrings) {
    List list = new ArrayList<>(formattedStrings.size());
    for (String formattedString : formattedStrings) {
      list.add(parse(formattedString));
    }
    return list;
  }

  public static List toStringList(List values) {
    List list = new ArrayList<>(values.size());
    for (KeywordPlanName value : values) {
      if (value == null) {
        list.add("");
      } else {
        list.add(value.toString());
      }
    }
    return list;
  }

  public static boolean isParsableFrom(String formattedString) {
    return CUSTOMER_ID_KEYWORD_PLAN_ID.matches(formattedString);
  }

  @Override
  public Map getFieldValuesMap() {
    if (fieldValuesMap == null) {
      synchronized (this) {
        if (fieldValuesMap == null) {
          ImmutableMap.Builder fieldMapBuilder = ImmutableMap.builder();
          if (customerId != null) {
            fieldMapBuilder.put("customer_id", customerId);
          }
          if (keywordPlanId != null) {
            fieldMapBuilder.put("keyword_plan_id", keywordPlanId);
          }
          fieldValuesMap = fieldMapBuilder.build();
        }
      }
    }
    return fieldValuesMap;
  }

  public String getFieldValue(String fieldName) {
    return getFieldValuesMap().get(fieldName);
  }

  @Override
  public String toString() {
    return CUSTOMER_ID_KEYWORD_PLAN_ID.instantiate(
        "customer_id", customerId, "keyword_plan_id", keywordPlanId);
  }

  @Override
  public boolean equals(Object o) {
    if (o == this) {
      return true;
    }
    if (o != null && getClass() == o.getClass()) {
      KeywordPlanName that = ((KeywordPlanName) o);
      return Objects.equals(this.customerId, that.customerId)
          && Objects.equals(this.keywordPlanId, that.keywordPlanId);
    }
    return false;
  }

  @Override
  public int hashCode() {
    int h = 1;
    h *= 1000003;
    h ^= Objects.hashCode(customerId);
    h *= 1000003;
    h ^= Objects.hashCode(keywordPlanId);
    return h;
  }

  /** Builder for customers/{customer_id}/keywordPlans/{keyword_plan_id}. */
  public static class Builder {
    private String customerId;
    private String keywordPlanId;

    protected Builder() {}

    public String getCustomerId() {
      return customerId;
    }

    public String getKeywordPlanId() {
      return keywordPlanId;
    }

    public Builder setCustomerId(String customerId) {
      this.customerId = customerId;
      return this;
    }

    public Builder setKeywordPlanId(String keywordPlanId) {
      this.keywordPlanId = keywordPlanId;
      return this;
    }

    private Builder(KeywordPlanName keywordPlanName) {
      this.customerId = keywordPlanName.customerId;
      this.keywordPlanId = keywordPlanName.keywordPlanId;
    }

    public KeywordPlanName build() {
      return new KeywordPlanName(this);
    }
  }
}