com.contrastsecurity.sdk.scan.ProjectsQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of contrast-sdk-java Show documentation

Java SDK for using Contrast Security APIs

There is a newer version: 3.4.2

package com.contrastsecurity.sdk.scan;

/*-
 * #%L
 * Contrast Java SDK
 * %%
 * Copyright (C) 2021 Contrast Security, Inc.
 * %%
 * 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.
 * #L%
 */

import com.contrastsecurity.sdk.internal.Nullable;
import com.google.auto.value.AutoValue;

/** Value type that describes a projects resource collection query predicate. */
@AutoValue
abstract class ProjectsQuery {

  /** @return new {@link Builder} */
  static Builder builder() {
    return new AutoValue_ProjectsQuery.Builder();
  }

  /** @return project name, or {@code null} to accept API default behavior. */
  @Nullable
  abstract String name();

  /**
   * @return true if the query will include archived projects, or {@code null} to accept API default
   *     behavior.
   */
  @Nullable
  abstract Boolean archived();

  /**
   * @return true if the projects resources should use exact string matching on the project name
   *     instead of a "contains" comparison, or {@code null} to accept the API default behavior.
   */
  @Nullable
  abstract Boolean unique();

  /** Builder for {@link ProjectsQuery}. */
  @AutoValue.Builder
  abstract static class Builder {

    abstract Builder name(String value);

    abstract Builder archived(Boolean value);

    abstract Builder unique(Boolean value);

    /** @return new {@code ProjectsQuery} */
    abstract ProjectsQuery build();
  }
}