public static final class GrpcStorageOptions . Builder extends StorageOptions . Builder
Inherited Members
com.google.cloud.ServiceOptions.Builder.getAllowedClientLibTokens()
com.google.cloud.ServiceOptions.Builder.self()
com.google.cloud.ServiceOptions.Builder.setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory)
com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setClock(com.google.api.core.ApiClock)
com.google.cloud.ServiceOptions.Builder.setCredentials(com.google.auth.Credentials)
com.google.cloud.ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)
com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setProjectId(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setQuotaProjectId(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setRetrySettings(com.google.api.gax.retrying.RetrySettings)
com.google.cloud.ServiceOptions.Builder.setServiceFactory(com.google.cloud.ServiceFactory<ServiceT,OptionsT>)
com.google.cloud.ServiceOptions.Builder.setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<OptionsT>)
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)
com.google.cloud.ServiceOptions.Builder.setUniverseDomain(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setUseJwtAccessWithScope(boolean)
Methods
build()
public GrpcStorageOptions build ()
Overrides
self()
protected GrpcStorageOptions . Builder self ()
Overrides
com.google.cloud.ServiceOptions.Builder.self()
setApiTracerFactory(ApiTracerFactory apiTracerFactory)
public GrpcStorageOptions . Builder setApiTracerFactory ( ApiTracerFactory apiTracerFactory )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Overrides
com.google.cloud.ServiceOptions.Builder.setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory)
setAttemptDirectPath(boolean attemptDirectPath)
public GrpcStorageOptions . Builder setAttemptDirectPath ( boolean attemptDirectPath )
Option which signifies the client should attempt to connect to gcs via Direct Google Access.
NOTE There is no need to specify a new endpoint via #setHost(String) as the
underlying code will translate the normal https://storage.googleapis.com:443 into the
proper Direct Google Access URI for you.
Parameter
Name
Description
attemptDirectPath
boolean
setAttemptDirectPathXdsOverInterconnect(boolean attemptDirectPathXdsOverInterconnect)
public GrpcStorageOptions . Builder setAttemptDirectPathXdsOverInterconnect ( boolean attemptDirectPathXdsOverInterconnect )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Option for whether this client should attempt to use DirectPath over Interconnect (on-premise
xDS name resolution).
This can also be enabled or disabled via the
GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS_OVER_INTERCONNECT environment variable ("true"
or "false"), which takes precedence over this builder option.
Parameter
Name
Description
attemptDirectPathXdsOverInterconnect
boolean
setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)
public GrpcStorageOptions . Builder setBlobWriteSessionConfig ( @NonNull BlobWriteSessionConfig blobWriteSessionConfig )
Parameter
Name
Description
blobWriteSessionConfig
@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.BlobWriteSessionConfig
Overrides
setClientLibToken(String clientLibToken)
public GrpcStorageOptions . Builder setClientLibToken ( String clientLibToken )
Parameter
Name
Description
clientLibToken
String
Overrides
com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)
setClock(ApiClock clock)
public GrpcStorageOptions . Builder setClock ( ApiClock clock )
Parameter
Name
Description
clock
ApiClock
Overrides
com.google.cloud.ServiceOptions.Builder.setClock(com.google.api.core.ApiClock)
setCredentials(Credentials credentials)
public GrpcStorageOptions . Builder setCredentials ( Credentials credentials )
Parameter
Name
Description
credentials
com.google.auth.Credentials
Overrides
com.google.cloud.ServiceOptions.Builder.setCredentials(com.google.auth.Credentials)
setEnableGrpcClientMetrics(boolean enableGrpcClientMetrics)
public GrpcStorageOptions . Builder setEnableGrpcClientMetrics ( boolean enableGrpcClientMetrics )
Option for whether this client should emit internal gRPC client internal metrics to Cloud
Monitoring. To disable metric reporting, set this to false. True by default. Emitting metrics
is free and requires minimal CPU and memory.
Parameter
Name
Description
enableGrpcClientMetrics
boolean
setEnableOtelDebugMetrics(boolean enableOtelDebugMetrics)
public GrpcStorageOptions . Builder setEnableOtelDebugMetrics ( boolean enableOtelDebugMetrics )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Enable or disable OpenTelemetry debug client metrics.
Parameter
Name
Description
enableOtelDebugMetrics
boolean whether OpenTelemetry debug client metrics should be enabled
Overrides
setEnableOtelMetrics(boolean enableOtelMetrics)
public GrpcStorageOptions . Builder setEnableOtelMetrics ( boolean enableOtelMetrics )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Enable or disable OpenTelemetry client metrics.
Parameter
Name
Description
enableOtelMetrics
boolean whether OpenTelemetry client metrics should be enabled
Overrides
setGrpcInterceptorProvider(@NonNull GrpcInterceptorProvider grpcInterceptorProvider)
public GrpcStorageOptions . Builder setGrpcInterceptorProvider ( @NonNull GrpcInterceptorProvider grpcInterceptorProvider )
Parameter
Name
Description
grpcInterceptorProvider
@org.checkerframework.checker.nullness.qual.NonNull com.google.api.gax.grpc.GrpcInterceptorProvider
public GrpcStorageOptions . Builder setHeaderProvider ( HeaderProvider headerProvider )
Overrides
com.google.cloud.ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)
setHost(String host)
public GrpcStorageOptions . Builder setHost ( String host )
Parameter
Name
Description
host
String
Overrides
com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)
setMeterProvider(@Nullable MeterProvider meterProvider)
public GrpcStorageOptions . Builder setMeterProvider ( @Nullable MeterProvider meterProvider )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Set a custom MeterProvider for recording client metrics.
Parameter
Name
Description
meterProvider
@org.checkerframework.checker.nullness.qual.Nullable io.opentelemetry.api.metrics.MeterProvider custom MeterProvider to use, or null to use the default
Overrides
setMetricInterval(Duration metricInterval)
public GrpcStorageOptions . Builder setMetricInterval ( Duration metricInterval )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Set the metric export interval for periodic metric reading.
When using the default Cloud Monitoring exporter, the interval must be at least 60 seconds
(1 minute). Intervals less than 60 seconds are permitted only when a custom MeterProvider is configured via #setMeterProvider(MeterProvider) or explicit
OpenTelemetry is configured via #setOpenTelemetry(OpenTelemetry) .
Parameter
Name
Description
metricInterval
Duration interval duration
Overrides
setOpenTelemetry(OpenTelemetry openTelemetry)
public GrpcStorageOptions . Builder setOpenTelemetry ( OpenTelemetry openTelemetry )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Enable OpenTelemetry Tracing and provide an instance for the client to use.
Parameter
Name
Description
openTelemetry
io.opentelemetry.api.OpenTelemetry User defined instance of OpenTelemetry to be used by the library
Overrides
setProjectId(String projectId)
public GrpcStorageOptions . Builder setProjectId ( String projectId )
Parameter
Name
Description
projectId
String
Overrides
com.google.cloud.ServiceOptions.Builder.setProjectId(java.lang.String)
setQuotaProjectId(String quotaProjectId)
public GrpcStorageOptions . Builder setQuotaProjectId ( String quotaProjectId )
Parameter
Name
Description
quotaProjectId
String
Overrides
com.google.cloud.ServiceOptions.Builder.setQuotaProjectId(java.lang.String)
setRetrySettings(RetrySettings retrySettings)
public GrpcStorageOptions . Builder setRetrySettings ( RetrySettings retrySettings )
Overrides
com.google.cloud.ServiceOptions.Builder.setRetrySettings(com.google.api.gax.retrying.RetrySettings)
setServiceFactory(ServiceFactory<Storage,StorageOptions> serviceFactory)
public GrpcStorageOptions . Builder setServiceFactory ( ServiceFactory<Storage , StorageOptions > serviceFactory )
Overrides
com.google.cloud.ServiceOptions.Builder.setServiceFactory(com.google.cloud.ServiceFactory<ServiceT,OptionsT>)
setServiceRpcFactory(ServiceRpcFactory<StorageOptions> serviceRpcFactory)
public GrpcStorageOptions . Builder setServiceRpcFactory ( ServiceRpcFactory<StorageOptions> serviceRpcFactory )
Parameter
Name
Description
serviceRpcFactory
com.google.cloud.spi.ServiceRpcFactory <StorageOptions >
Overrides
com.google.cloud.ServiceOptions.Builder.setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<OptionsT>)
setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)
public GrpcStorageOptions . Builder setStorageRetryStrategy ( StorageRetryStrategy storageRetryStrategy )
Parameter
Name
Description
storageRetryStrategy
StorageRetryStrategy a non-null storageRetryStrategy to use
Overrides
setTerminationAwaitDuration(Duration terminationAwaitDuration)
public GrpcStorageOptions . Builder setTerminationAwaitDuration ( Duration terminationAwaitDuration )
Parameter
Name
Description
terminationAwaitDuration
org.threeten.bp.Duration
setTerminationAwaitJavaTimeDuration(Duration terminationAwaitDuration)
public GrpcStorageOptions . Builder setTerminationAwaitJavaTimeDuration ( Duration terminationAwaitDuration )
Set the maximum duration in which to await termination of any outstanding requests when
calling Storage#close()
Parameter
Name
Description
terminationAwaitDuration
Duration a non-null Duration to use
setTransportOptions(TransportOptions transportOptions)
public GrpcStorageOptions . Builder setTransportOptions ( TransportOptions transportOptions )
Parameter
Name
Description
transportOptions
com.google.cloud.TransportOptions
Overrides
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)
setUniverseDomain(String universeDomain)
public GrpcStorageOptions . Builder setUniverseDomain ( String universeDomain )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Parameter
Name
Description
universeDomain
String
Overrides
com.google.cloud.ServiceOptions.Builder.setUniverseDomain(java.lang.String)