com.google.cloud.datastore.models.ExplainOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-datastore Show documentation

Java idiomatic client for Google Cloud Datastore.

There is a newer version: 2.24.2

Show 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.cloud.datastore.models;

import com.google.api.core.BetaApi;
import com.google.api.core.InternalApi;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Objects;

/**
 * Model class for {@link com.google.datastore.v1.ExplainOptions}. Contains the explain options for
 * the query. Analyze is set to 'false' by default.
 */
@BetaApi
public class ExplainOptions {
  private final com.google.datastore.v1.ExplainOptions proto;

  private ExplainOptions(com.google.datastore.v1.ExplainOptions proto) {
    this.proto = proto;
  }

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

  /**
   * Returns whether analyze is set to true or false. When false (the default), the query will be
   * planned, returning only metrics from the planning stages. When true, the query will be planned
   * and executed, returning the full query results along with both planning and execution stage
   * metrics.
   */
  public boolean shouldAnalyze() {
    return proto.getAnalyze();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (!(o instanceof ExplainOptions)) return false;
    ExplainOptions that = (ExplainOptions) o;
    return proto.equals(that.proto);
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(proto);
  }

  @InternalApi
  @VisibleForTesting
  public com.google.datastore.v1.ExplainOptions toPb() {
    return this.proto;
  }

  public static class Builder {
    private boolean analyze = false;

    /*
     * Set 'analyze' to true or false for the explain options.
     * When false (the default), the query will be planned, returning only metrics from the planning stages.
     * When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
     */
    public Builder setAnalyze(boolean analyze) {
      this.analyze = analyze;
      return this;
    }

    public ExplainOptions build() {
      return new ExplainOptions(
          com.google.datastore.v1.ExplainOptions.newBuilder().setAnalyze(this.analyze).build());
    }
  }
}