Package com.google.cloud.storage

Class GrpcStorageOptions.Builder

java.lang.Object

com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

com.google.cloud.storage.StorageOptions.Builder

com.google.cloud.storage.GrpcStorageOptions.Builder

Enclosing class:

GrpcStorageOptions

public static final class GrpcStorageOptions.Builder
extends StorageOptions.Builder

Since:

2.14.0

Field Summary

Fields inherited from class com.google.cloud.ServiceOptions.Builder

credentials

Method Summary

Modifier and Type	Method	Description
GrpcStorageOptions	build()
protected GrpcStorageOptions.Builder	self()
GrpcStorageOptions.Builder	setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory apiTracerFactory)
GrpcStorageOptions.Builder	setAttemptDirectPath(boolean attemptDirectPath)	Option which signifies the client should attempt to connect to gcs via Direct Google Access.
GrpcStorageOptions.Builder	setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)
GrpcStorageOptions.Builder	setClientLibToken(String clientLibToken)
GrpcStorageOptions.Builder	setClock(com.google.api.core.ApiClock clock)
GrpcStorageOptions.Builder	setCredentials(com.google.auth.Credentials credentials)
GrpcStorageOptions.Builder	setEnableGrpcClientMetrics(boolean enableGrpcClientMetrics)	Option for whether this client should emit internal gRPC client internal metrics to Cloud Monitoring.
GrpcStorageOptions.Builder	setGrpcInterceptorProvider(@NonNull com.google.api.gax.grpc.GrpcInterceptorProvider grpcInterceptorProvider)
GrpcStorageOptions.Builder	setHeaderProvider(com.google.api.gax.rpc.HeaderProvider headerProvider)
GrpcStorageOptions.Builder	setHost(String host)
GrpcStorageOptions.Builder	setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	Enable OpenTelemetry Tracing and provide an instance for the client to use.
GrpcStorageOptions.Builder	setProjectId(String projectId)
GrpcStorageOptions.Builder	setQuotaProjectId(String quotaProjectId)
GrpcStorageOptions.Builder	setRetrySettings(com.google.api.gax.retrying.RetrySettings retrySettings)
GrpcStorageOptions.Builder	setServiceFactory(com.google.cloud.ServiceFactory<Storage,StorageOptions> serviceFactory)
GrpcStorageOptions.Builder	setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<StorageOptions> serviceRpcFactory)
GrpcStorageOptions.Builder	setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)	Override the default retry handling behavior with an alternate strategy.
GrpcStorageOptions.Builder	setTerminationAwaitDuration(org.threeten.bp.Duration terminationAwaitDuration)	This method is obsolete.
GrpcStorageOptions.Builder	setTerminationAwaitJavaTimeDuration(Duration terminationAwaitDuration)	Set the maximum duration in which to await termination of any outstanding requests when calling Storage.close()
GrpcStorageOptions.Builder	setTransportOptions(com.google.cloud.TransportOptions transportOptions)
GrpcStorageOptions.Builder	setUniverseDomain(String universeDomain)

Methods inherited from class com.google.cloud.ServiceOptions.Builder

getAllowedClientLibTokens

Methods inherited from class java.lang.Object

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

Method Details

setTerminationAwaitDuration

@ObsoleteApi("Use setTerminationAwaitJavaTimeDuration(java.time.Duration) instead")
public GrpcStorageOptions.Builder setTerminationAwaitDuration(org.threeten.bp.Duration terminationAwaitDuration)

This method is obsolete. Use setTerminationAwaitJavaTimeDuration(java.time.Duration) instead.

setTerminationAwaitJavaTimeDuration

public GrpcStorageOptions.Builder setTerminationAwaitJavaTimeDuration(Duration terminationAwaitDuration)

Set the maximum duration in which to await termination of any outstanding requests when calling Storage.close()

Parameters:

terminationAwaitDuration - a non-null Duration to use

Returns:

the builder

Since:

2.14.0

setAttemptDirectPath

public GrpcStorageOptions.Builder setAttemptDirectPath(boolean attemptDirectPath)

Option which signifies the client should attempt to connect to gcs via Direct Google Access.

NOTEThere 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.

Since:

2.14.0

setEnableGrpcClientMetrics

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.

Since:

2.41.0

setTransportOptions

public GrpcStorageOptions.Builder setTransportOptions(com.google.cloud.TransportOptions transportOptions)

Overrides:

setTransportOptions in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setStorageRetryStrategy

public GrpcStorageOptions.Builder setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)

Override the default retry handling behavior with an alternate strategy.

Specified by:

setStorageRetryStrategy in class StorageOptions.Builder

Parameters:

storageRetryStrategy - a non-null storageRetryStrategy to use

Returns:

the builder

Since:

2.14.0

See Also:

• StorageRetryStrategy.getDefaultStorageRetryStrategy()

self

protected GrpcStorageOptions.Builder self()

Overrides:

self in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

setServiceFactory

public GrpcStorageOptions.Builder setServiceFactory(com.google.cloud.ServiceFactory<Storage,StorageOptions> serviceFactory)

Overrides:

setServiceFactory in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setClock

public GrpcStorageOptions.Builder setClock(com.google.api.core.ApiClock clock)

Overrides:

setClock in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setProjectId

public GrpcStorageOptions.Builder setProjectId(String projectId)

Overrides:

setProjectId in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setHost

public GrpcStorageOptions.Builder setHost(String host)

Overrides:

setHost in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setCredentials

public GrpcStorageOptions.Builder setCredentials(com.google.auth.Credentials credentials)

Overrides:

setCredentials in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setRetrySettings

public GrpcStorageOptions.Builder setRetrySettings(com.google.api.gax.retrying.RetrySettings retrySettings)

Overrides:

setRetrySettings in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setServiceRpcFactory

public GrpcStorageOptions.Builder setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<StorageOptions> serviceRpcFactory)

Overrides:

setServiceRpcFactory in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setHeaderProvider

public GrpcStorageOptions.Builder setHeaderProvider(com.google.api.gax.rpc.HeaderProvider headerProvider)

Overrides:

setHeaderProvider in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setClientLibToken

public GrpcStorageOptions.Builder setClientLibToken(String clientLibToken)

Overrides:

setClientLibToken in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setQuotaProjectId

public GrpcStorageOptions.Builder setQuotaProjectId(String quotaProjectId)

Overrides:

setQuotaProjectId in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

Since:

2.14.0

setGrpcInterceptorProvider

public GrpcStorageOptions.Builder setGrpcInterceptorProvider(@NonNull com.google.api.gax.grpc.GrpcInterceptorProvider grpcInterceptorProvider)

Since:

2.22.3

setBlobWriteSessionConfig

@BetaApi
public GrpcStorageOptions.Builder setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)

Specified by:

setBlobWriteSessionConfig in class StorageOptions.Builder

Since:

2.26.0 This new api is in preview and is subject to breaking changes.

See Also:

• BlobWriteSessionConfig
• BlobWriteSessionConfigs
• Storage.blobWriteSession(BlobInfo, BlobWriteOption...)
• GrpcStorageOptions.GrpcStorageDefaults.getDefaultStorageWriterConfig()

setUniverseDomain

@BetaApi
public GrpcStorageOptions.Builder setUniverseDomain(String universeDomain)

Overrides:

setUniverseDomain in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

setApiTracerFactory

@BetaApi
public GrpcStorageOptions.Builder setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory apiTracerFactory)

Overrides:

setApiTracerFactory in class com.google.cloud.ServiceOptions.Builder<Storage,StorageOptions,StorageOptions.Builder>

setOpenTelemetry

@BetaApi
public GrpcStorageOptions.Builder setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

Enable OpenTelemetry Tracing and provide an instance for the client to use.

Specified by:

setOpenTelemetry in class StorageOptions.Builder

Parameters:

openTelemetry - User defined instance of OpenTelemetry to be used by the library

Since:

2.47.0 This new api is in preview and is subject to breaking changes.

build

public GrpcStorageOptions build()

Specified by:

build in class StorageOptions.Builder

Since:

2.14.0