// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/config/trace/v3/opencensus.proto
package io.envoyproxy.envoy.config.trace.v3;
public interface OpenCensusConfigOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.config.trace.v3.OpenCensusConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
* Configures tracing, e.g. the sampler, max number of annotations, etc.
*
*
* .opencensus.proto.trace.v1.TraceConfig trace_config = 1;
* @return Whether the traceConfig field is set.
*/
boolean hasTraceConfig();
/**
*
* Configures tracing, e.g. the sampler, max number of annotations, etc.
*
*
* .opencensus.proto.trace.v1.TraceConfig trace_config = 1;
* @return The traceConfig.
*/
io.opencensus.proto.trace.v1.TraceConfig getTraceConfig();
/**
*
* Configures tracing, e.g. the sampler, max number of annotations, etc.
*
*
* .opencensus.proto.trace.v1.TraceConfig trace_config = 1;
*/
io.opencensus.proto.trace.v1.TraceConfigOrBuilder getTraceConfigOrBuilder();
/**
*
* Enables the stdout exporter if set to true. This is intended for debugging
* purposes.
*
*
* bool stdout_exporter_enabled = 2;
* @return The stdoutExporterEnabled.
*/
boolean getStdoutExporterEnabled();
/**
*
* Enables the Stackdriver exporter if set to true. The project_id must also
* be set.
*
*
* bool stackdriver_exporter_enabled = 3;
* @return The stackdriverExporterEnabled.
*/
boolean getStackdriverExporterEnabled();
/**
*
* The Cloud project_id to use for Stackdriver tracing.
*
*
* string stackdriver_project_id = 4;
* @return The stackdriverProjectId.
*/
java.lang.String getStackdriverProjectId();
/**
*
* The Cloud project_id to use for Stackdriver tracing.
*
*
* string stackdriver_project_id = 4;
* @return The bytes for stackdriverProjectId.
*/
com.google.protobuf.ByteString
getStackdriverProjectIdBytes();
/**
*
* (optional) By default, the Stackdriver exporter will connect to production
* Stackdriver. If stackdriver_address is non-empty, it will instead connect
* to this address, which is in the gRPC format:
* https://github.com/grpc/grpc/blob/master/doc/naming.md
*
*
* string stackdriver_address = 10;
* @return The stackdriverAddress.
*/
java.lang.String getStackdriverAddress();
/**
*
* (optional) By default, the Stackdriver exporter will connect to production
* Stackdriver. If stackdriver_address is non-empty, it will instead connect
* to this address, which is in the gRPC format:
* https://github.com/grpc/grpc/blob/master/doc/naming.md
*
*
* string stackdriver_address = 10;
* @return The bytes for stackdriverAddress.
*/
com.google.protobuf.ByteString
getStackdriverAddressBytes();
/**
*
* (optional) The gRPC server that hosts Stackdriver tracing service. Only
* Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
* is not provided, the default production Stackdriver address will be used.
*
*
* .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;
* @return Whether the stackdriverGrpcService field is set.
*/
boolean hasStackdriverGrpcService();
/**
*
* (optional) The gRPC server that hosts Stackdriver tracing service. Only
* Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
* is not provided, the default production Stackdriver address will be used.
*
*
* .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;
* @return The stackdriverGrpcService.
*/
io.envoyproxy.envoy.config.core.v3.GrpcService getStackdriverGrpcService();
/**
*
* (optional) The gRPC server that hosts Stackdriver tracing service. Only
* Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
* is not provided, the default production Stackdriver address will be used.
*
*
* .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;
*/
io.envoyproxy.envoy.config.core.v3.GrpcServiceOrBuilder getStackdriverGrpcServiceOrBuilder();
/**
*
* Enables the Zipkin exporter if set to true. The url and service name must
* also be set. This is deprecated, prefer to use Envoy's :ref:`native Zipkin
* tracer <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
*
*
* bool zipkin_exporter_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
* @deprecated envoy.config.trace.v3.OpenCensusConfig.zipkin_exporter_enabled is deprecated.
* See envoy/config/trace/v3/opencensus.proto;l=77
* @return The zipkinExporterEnabled.
*/
@java.lang.Deprecated boolean getZipkinExporterEnabled();
/**
*
* The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans". This is
* deprecated, prefer to use Envoy's :ref:`native Zipkin tracer
* <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
*
*
* string zipkin_url = 6 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
* @deprecated envoy.config.trace.v3.OpenCensusConfig.zipkin_url is deprecated.
* See envoy/config/trace/v3/opencensus.proto;l=83
* @return The zipkinUrl.
*/
@java.lang.Deprecated java.lang.String getZipkinUrl();
/**
*
* The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans". This is
* deprecated, prefer to use Envoy's :ref:`native Zipkin tracer
* <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
*
*
* string zipkin_url = 6 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
* @deprecated envoy.config.trace.v3.OpenCensusConfig.zipkin_url is deprecated.
* See envoy/config/trace/v3/opencensus.proto;l=83
* @return The bytes for zipkinUrl.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getZipkinUrlBytes();
/**
*
* Enables the OpenCensus Agent exporter if set to true. The ocagent_address or
* ocagent_grpc_service must also be set.
*
*
* bool ocagent_exporter_enabled = 11;
* @return The ocagentExporterEnabled.
*/
boolean getOcagentExporterEnabled();
/**
*
* The address of the OpenCensus Agent, if its exporter is enabled, in gRPC
* format: https://github.com/grpc/grpc/blob/master/doc/naming.md
* [#comment:TODO: deprecate this field]
*
*
* string ocagent_address = 12;
* @return The ocagentAddress.
*/
java.lang.String getOcagentAddress();
/**
*
* The address of the OpenCensus Agent, if its exporter is enabled, in gRPC
* format: https://github.com/grpc/grpc/blob/master/doc/naming.md
* [#comment:TODO: deprecate this field]
*
*
* string ocagent_address = 12;
* @return The bytes for ocagentAddress.
*/
com.google.protobuf.ByteString
getOcagentAddressBytes();
/**
*
* (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
* This is only used if the ocagent_address is left empty.
*
*
* .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;
* @return Whether the ocagentGrpcService field is set.
*/
boolean hasOcagentGrpcService();
/**
*
* (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
* This is only used if the ocagent_address is left empty.
*
*
* .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;
* @return The ocagentGrpcService.
*/
io.envoyproxy.envoy.config.core.v3.GrpcService getOcagentGrpcService();
/**
*
* (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
* This is only used if the ocagent_address is left empty.
*
*
* .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;
*/
io.envoyproxy.envoy.config.core.v3.GrpcServiceOrBuilder getOcagentGrpcServiceOrBuilder();
/**
*
* List of incoming trace context headers we will accept. First one found
* wins.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
* @return A list containing the incomingTraceContext.
*/
java.util.List getIncomingTraceContextList();
/**
*
* List of incoming trace context headers we will accept. First one found
* wins.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
* @return The count of incomingTraceContext.
*/
int getIncomingTraceContextCount();
/**
*
* List of incoming trace context headers we will accept. First one found
* wins.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
* @param index The index of the element to return.
* @return The incomingTraceContext at the given index.
*/
io.envoyproxy.envoy.config.trace.v3.OpenCensusConfig.TraceContext getIncomingTraceContext(int index);
/**
*
* List of incoming trace context headers we will accept. First one found
* wins.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
* @return A list containing the enum numeric values on the wire for incomingTraceContext.
*/
java.util.List
getIncomingTraceContextValueList();
/**
*
* List of incoming trace context headers we will accept. First one found
* wins.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
* @param index The index of the value to return.
* @return The enum numeric value on the wire of incomingTraceContext at the given index.
*/
int getIncomingTraceContextValue(int index);
/**
*
* List of outgoing trace context headers we will produce.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
* @return A list containing the outgoingTraceContext.
*/
java.util.List getOutgoingTraceContextList();
/**
*
* List of outgoing trace context headers we will produce.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
* @return The count of outgoingTraceContext.
*/
int getOutgoingTraceContextCount();
/**
*
* List of outgoing trace context headers we will produce.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
* @param index The index of the element to return.
* @return The outgoingTraceContext at the given index.
*/
io.envoyproxy.envoy.config.trace.v3.OpenCensusConfig.TraceContext getOutgoingTraceContext(int index);
/**
*
* List of outgoing trace context headers we will produce.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
* @return A list containing the enum numeric values on the wire for outgoingTraceContext.
*/
java.util.List
getOutgoingTraceContextValueList();
/**
*
* List of outgoing trace context headers we will produce.
*
*
* repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
* @param index The index of the value to return.
* @return The enum numeric value on the wire of outgoingTraceContext at the given index.
*/
int getOutgoingTraceContextValue(int index);
}
