Package com.google.cloud.grpc

Class GcpManagedChannelOptions.Builder

java.lang.Object

com.google.cloud.grpc.GcpManagedChannelOptions.Builder

Enclosing class:

GcpManagedChannelOptions

public static class GcpManagedChannelOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(GcpManagedChannelOptions options)

Method Summary

Modifier and Type	Method	Description
GcpManagedChannelOptions	build()
GcpManagedChannelOptions.Builder	withChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions channelPoolOptions)	Sets the channel pool configuration for the GcpManagedChannel.
GcpManagedChannelOptions.Builder	withMetricsOptions(GcpManagedChannelOptions.GcpMetricsOptions metricsOptions)	Sets the metrics configuration for the GcpManagedChannel.
GcpManagedChannelOptions.Builder	withResiliencyOptions(GcpManagedChannelOptions.GcpResiliencyOptions resiliencyOptions)	Sets the resiliency configuration for the GcpManagedChannel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Builder

public Builder(GcpManagedChannelOptions options)

Method Details

build

public GcpManagedChannelOptions build()

withChannelPoolOptions

public GcpManagedChannelOptions.Builder withChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions channelPoolOptions)

Sets the channel pool configuration for the GcpManagedChannel.

Parameters:

channelPoolOptions - a GcpManagedChannelOptions.GcpChannelPoolOptions to use as a channel pool configuration.

withMetricsOptions

public GcpManagedChannelOptions.Builder withMetricsOptions(GcpManagedChannelOptions.GcpMetricsOptions metricsOptions)

Sets the metrics configuration for the GcpManagedChannel.

If a MetricRegistry is provided in GcpManagedChannelOptions.GcpMetricsOptions then the GcpManagedChannel will emit metrics using that registry. The metrics options also allow to set up labels (tags) and a prefix for metrics names. The GcpManagedChannel will add its own label "pool_index" with values "pool-0", "pool-1", etc. for each instance of GcpManagedChannel created.

Example usage (e. g. with export to Cloud Monitoring)

 // Enable Cloud Monitoring exporter.
 StackdriverStatsExporter.createAndRegister();

 // Configure metrics options.
 GcpMetricsOptions metricsOptions = GcpMetricsOptions.newBuilder(Metrics.getMetricRegistry())
     .withNamePrefix("myapp/gcp-pool/")
     .build());

 final GcpManagedChannel pool =
     (GcpManagedChannel)
         GcpManagedChannelBuilder.forDelegateBuilder(builder)
             .withOptions(
                 GcpManagedChannelOptions.newBuilder()
                     .withMetricsOptions(metricsOptions)
                     .build())
             .build();

 // Use the pool that will emit metrics which will be exported to Cloud Monitoring.
 

Parameters:

metricsOptions - a GcpManagedChannelOptions.GcpMetricsOptions to use as metrics configuration.

withResiliencyOptions

public GcpManagedChannelOptions.Builder withResiliencyOptions(GcpManagedChannelOptions.GcpResiliencyOptions resiliencyOptions)

Sets the resiliency configuration for the GcpManagedChannel.

Parameters:

resiliencyOptions - a GcpManagedChannelOptions.GcpResiliencyOptions to use as resiliency configuration.