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

@BetaApi
public static final class GrpcStorageOptions.Builder
extends StorageOptions.Builder

Since:

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

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	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	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)	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)

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

getAllowedClientLibTokens, setApiTracerFactory, setUniverseDomain

Methods inherited from class java.lang.Object

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

Method Details

setTerminationAwaitDuration

@BetaApi
public GrpcStorageOptions.Builder setTerminationAwaitDuration(org.threeten.bp.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 This new api is in preview and is subject to breaking changes.

setAttemptDirectPath

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setEnableGrpcClientMetrics

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setTransportOptions

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setStorageRetryStrategy

@BetaApi
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 This new api is in preview and is subject to breaking changes.

See Also:

• StorageRetryStrategy.getDefaultStorageRetryStrategy()

self

protected GrpcStorageOptions.Builder self()

Overrides:

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

setServiceFactory

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setClock

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setProjectId

@BetaApi
public GrpcStorageOptions.Builder setProjectId(String projectId)

Overrides:

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

Since:

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

setHost

@BetaApi
public GrpcStorageOptions.Builder setHost(String host)

Overrides:

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

Since:

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

setCredentials

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setRetrySettings

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setServiceRpcFactory

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setHeaderProvider

@BetaApi
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 This new api is in preview and is subject to breaking changes.

setClientLibToken

@BetaApi
public GrpcStorageOptions.Builder setClientLibToken(String clientLibToken)

Overrides:

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

Since:

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

setQuotaProjectId

@BetaApi
public GrpcStorageOptions.Builder setQuotaProjectId(String quotaProjectId)

Overrides:

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

Since:

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

setGrpcInterceptorProvider

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

Since:

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

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

build

@BetaApi
public GrpcStorageOptions build()

Specified by:

build in class StorageOptions.Builder

Since:

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