OpenCensusConfigOrBuilder (api 0.1.28 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OpenCensusConfig, OpenCensusConfig.Builder
```
public interface OpenCensusConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OpenCensusConfig.TraceContext`	`getIncomingTraceContext(int index)` List of incoming trace context headers we will accept.
`int`	`getIncomingTraceContextCount()` List of incoming trace context headers we will accept.
`List<OpenCensusConfig.TraceContext>`	`getIncomingTraceContextList()` List of incoming trace context headers we will accept.
`int`	`getIncomingTraceContextValue(int index)` List of incoming trace context headers we will accept.
`List<Integer>`	`getIncomingTraceContextValueList()` List of incoming trace context headers we will accept.
`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;`
`com.google.protobuf.ByteString`	`getOcagentAddressBytes()` 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;`
`boolean`	`getOcagentExporterEnabled()` Enables the OpenCensus Agent exporter if set to true.
`GrpcService`	`getOcagentGrpcService()` (optional) The gRPC server hosted by the OpenCensus Agent.
`GrpcServiceOrBuilder`	`getOcagentGrpcServiceOrBuilder()` (optional) The gRPC server hosted by the OpenCensus Agent.
`OpenCensusConfig.TraceContext`	`getOutgoingTraceContext(int index)` List of outgoing trace context headers we will produce.
`int`	`getOutgoingTraceContextCount()` List of outgoing trace context headers we will produce.
`List<OpenCensusConfig.TraceContext>`	`getOutgoingTraceContextList()` List of outgoing trace context headers we will produce.
`int`	`getOutgoingTraceContextValue(int index)` List of outgoing trace context headers we will produce.
`List<Integer>`	`getOutgoingTraceContextValueList()` List of outgoing trace context headers we will produce.
`String`	`getStackdriverAddress()` (optional) By default, the Stackdriver exporter will connect to production Stackdriver.
`com.google.protobuf.ByteString`	`getStackdriverAddressBytes()` (optional) By default, the Stackdriver exporter will connect to production Stackdriver.
`boolean`	`getStackdriverExporterEnabled()` Enables the Stackdriver exporter if set to true.
`GrpcService`	`getStackdriverGrpcService()` (optional) The gRPC server that hosts Stackdriver tracing service.
`GrpcServiceOrBuilder`	`getStackdriverGrpcServiceOrBuilder()` (optional) The gRPC server that hosts Stackdriver tracing service.
`String`	`getStackdriverProjectId()` The Cloud project_id to use for Stackdriver tracing.
`com.google.protobuf.ByteString`	`getStackdriverProjectIdBytes()` The Cloud project_id to use for Stackdriver tracing.
`boolean`	`getStdoutExporterEnabled()` Enables the stdout exporter if set to true.
`TraceConfig`	`getTraceConfig()` Configures tracing, e.g. the sampler, max number of annotations, etc.
`TraceConfigOrBuilder`	`getTraceConfigOrBuilder()` Configures tracing, e.g. the sampler, max number of annotations, etc.
`boolean`	`getZipkinExporterEnabled()` Enables the Zipkin exporter if set to true.
`String`	`getZipkinUrl()` The URL to Zipkin, e.g.
`com.google.protobuf.ByteString`	`getZipkinUrlBytes()` The URL to Zipkin, e.g.
`boolean`	`hasOcagentGrpcService()` (optional) The gRPC server hosted by the OpenCensus Agent.
`boolean`	`hasStackdriverGrpcService()` (optional) The gRPC server that hosts Stackdriver tracing service.
`boolean`	`hasTraceConfig()` Configures tracing, e.g. the sampler, max number of annotations, etc.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasTraceConfig

boolean hasTraceConfig()

 Configures tracing, e.g. the sampler, max number of annotations, etc.

.opencensus.proto.trace.v1.TraceConfig trace_config = 1;

getTraceConfig

TraceConfig getTraceConfig()

 Configures tracing, e.g. the sampler, max number of annotations, etc.

.opencensus.proto.trace.v1.TraceConfig trace_config = 1;

getTraceConfigOrBuilder

TraceConfigOrBuilder getTraceConfigOrBuilder()

 Configures tracing, e.g. the sampler, max number of annotations, etc.

.opencensus.proto.trace.v1.TraceConfig trace_config = 1;

getStdoutExporterEnabled

boolean getStdoutExporterEnabled()

 Enables the stdout exporter if set to true. This is intended for debugging
 purposes.

bool stdout_exporter_enabled = 2;

getStackdriverExporterEnabled

boolean getStackdriverExporterEnabled()

 Enables the Stackdriver exporter if set to true. The project_id must also
 be set.

bool stackdriver_exporter_enabled = 3;

getStackdriverProjectId

String getStackdriverProjectId()

 The Cloud project_id to use for Stackdriver tracing.

string stackdriver_project_id = 4;

getStackdriverProjectIdBytes

com.google.protobuf.ByteString getStackdriverProjectIdBytes()

 The Cloud project_id to use for Stackdriver tracing.

string stackdriver_project_id = 4;

getStackdriverAddress

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;

getStackdriverAddressBytes

com.google.protobuf.ByteString getStackdriverAddressBytes()

 (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;

hasStackdriverGrpcService

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.api.v2.core.GrpcService stackdriver_grpc_service = 13;

getStackdriverGrpcService

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.api.v2.core.GrpcService stackdriver_grpc_service = 13;

getStackdriverGrpcServiceOrBuilder

GrpcServiceOrBuilder getStackdriverGrpcServiceOrBuilder()

 (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.api.v2.core.GrpcService stackdriver_grpc_service = 13;

getZipkinExporterEnabled

boolean getZipkinExporterEnabled()

 Enables the Zipkin exporter if set to true. The url and service name must
 also be set.

bool zipkin_exporter_enabled = 5;

getZipkinUrl

String getZipkinUrl()

 The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans"

string zipkin_url = 6;

getZipkinUrlBytes

com.google.protobuf.ByteString getZipkinUrlBytes()

 The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans"

string zipkin_url = 6;

getOcagentExporterEnabled

boolean getOcagentExporterEnabled()

 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;

getOcagentAddress

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;

getOcagentAddressBytes

com.google.protobuf.ByteString getOcagentAddressBytes()

 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;

hasOcagentGrpcService

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.api.v2.core.GrpcService ocagent_grpc_service = 14;

getOcagentGrpcService

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.api.v2.core.GrpcService ocagent_grpc_service = 14;

getOcagentGrpcServiceOrBuilder

GrpcServiceOrBuilder getOcagentGrpcServiceOrBuilder()

 (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.api.v2.core.GrpcService ocagent_grpc_service = 14;