/*
 * Copyright 2020 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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/compute/v1/compute.proto

package com.google.cloud.compute.v1;

public interface BackendServiceLogConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.BackendServiceLogConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
   * </pre>
   *
   * <code>optional bool enable = 311764355;</code>
   *
   * @return Whether the enable field is set.
   */
  boolean hasEnable();
  /**
   *
   *
   * <pre>
   * Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
   * </pre>
   *
   * <code>optional bool enable = 311764355;</code>
   *
   * @return The enable.
   */
  boolean getEnable();

  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
   * </pre>
   *
   * <code>repeated string optional_fields = 528589944;</code>
   *
   * @return A list containing the optionalFields.
   */
  java.util.List<java.lang.String> getOptionalFieldsList();
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
   * </pre>
   *
   * <code>repeated string optional_fields = 528589944;</code>
   *
   * @return The count of optionalFields.
   */
  int getOptionalFieldsCount();
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
   * </pre>
   *
   * <code>repeated string optional_fields = 528589944;</code>
   *
   * @param index The index of the element to return.
   * @return The optionalFields at the given index.
   */
  java.lang.String getOptionalFields(int index);
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
   * </pre>
   *
   * <code>repeated string optional_fields = 528589944;</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the optionalFields at the given index.
   */
  com.google.protobuf.ByteString getOptionalFieldsBytes(int index);

  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
   * Check the OptionalMode enum for the list of possible values.
   * </pre>
   *
   * <code>optional string optional_mode = 128697122;</code>
   *
   * @return Whether the optionalMode field is set.
   */
  boolean hasOptionalMode();
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
   * Check the OptionalMode enum for the list of possible values.
   * </pre>
   *
   * <code>optional string optional_mode = 128697122;</code>
   *
   * @return The optionalMode.
   */
  java.lang.String getOptionalMode();
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
   * Check the OptionalMode enum for the list of possible values.
   * </pre>
   *
   * <code>optional string optional_mode = 128697122;</code>
   *
   * @return The bytes for optionalMode.
   */
  com.google.protobuf.ByteString getOptionalModeBytes();

  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
   * </pre>
   *
   * <code>optional float sample_rate = 153193045;</code>
   *
   * @return Whether the sampleRate field is set.
   */
  boolean hasSampleRate();
  /**
   *
   *
   * <pre>
   * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
   * </pre>
   *
   * <code>optional float sample_rate = 153193045;</code>
   *
   * @return The sampleRate.
   */
  float getSampleRate();
}
