Class GrpcStorageOptions.Builder (2.46.0) 

public static final class GrpcStorageOptions.Builder extends StorageOptions.Builder

Inheritance

java.lang.Object > com.google.cloud.ServiceOptions.Builder > StorageOptions.Builder > GrpcStorageOptions.Builder

Methods

build()

public GrpcStorageOptions build()
Returns
Type Description
GrpcStorageOptions
Overrides

self()

protected GrpcStorageOptions.Builder self()
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.self()

setAttemptDirectPath(boolean attemptDirectPath)

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.

Parameter
Name Description
attemptDirectPath boolean
Returns
Type Description
GrpcStorageOptions.Builder

setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)

public GrpcStorageOptions.Builder setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)

See Also: Storage#blobWriteSession(BlobInfo, BlobWriteOption...), BlobWriteSessionConfigs, BlobWriteSessionConfig, GrpcStorageDefaults#getDefaultStorageWriterConfig()

Parameter
Name Description
blobWriteSessionConfig @org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.BlobWriteSessionConfig
Returns
Type Description
GrpcStorageOptions.Builder
Overrides

setClientLibToken(String clientLibToken)

public GrpcStorageOptions.Builder setClientLibToken(String clientLibToken)
Parameter
Name Description
clientLibToken String
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)

setClock(ApiClock clock)

public GrpcStorageOptions.Builder setClock(ApiClock clock)
Parameter
Name Description
clock ApiClock
Returns
Type Description
GrpcStorageOptions.Builder
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
Returns
Type Description
GrpcStorageOptions.Builder
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
Returns
Type Description
GrpcStorageOptions.Builder

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
Returns
Type Description
GrpcStorageOptions.Builder

setHeaderProvider(HeaderProvider headerProvider)

public GrpcStorageOptions.Builder setHeaderProvider(HeaderProvider headerProvider)
Parameter
Name Description
headerProvider HeaderProvider
Returns
Type Description
GrpcStorageOptions.Builder
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
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)

setProjectId(String projectId)

public GrpcStorageOptions.Builder setProjectId(String projectId)
Parameter
Name Description
projectId String
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setProjectId(java.lang.String)

setQuotaProjectId(String quotaProjectId)

public GrpcStorageOptions.Builder setQuotaProjectId(String quotaProjectId)
Parameter
Name Description
quotaProjectId String
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setQuotaProjectId(java.lang.String)

setRetrySettings(RetrySettings retrySettings)

public GrpcStorageOptions.Builder setRetrySettings(RetrySettings retrySettings)
Parameter
Name Description
retrySettings RetrySettings
Returns
Type Description
GrpcStorageOptions.Builder
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)
Parameter
Name Description
serviceFactory com.google.cloud.ServiceFactory<Storage,StorageOptions>
Returns
Type Description
GrpcStorageOptions.Builder
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>
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<OptionsT>)

setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)

public GrpcStorageOptions.Builder setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)

Override the default retry handling behavior with an alternate strategy. See Also: StorageRetryStrategy#getDefaultStorageRetryStrategy()

Parameter
Name Description
storageRetryStrategy StorageRetryStrategy

a non-null storageRetryStrategy to use
Returns
Type Description
GrpcStorageOptions.Builder

the builder
Overrides

setTerminationAwaitDuration(Duration terminationAwaitDuration)

public GrpcStorageOptions.Builder setTerminationAwaitDuration(Duration terminationAwaitDuration)

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

Parameter
Name Description
terminationAwaitDuration org.threeten.bp.Duration
Returns
Type Description
GrpcStorageOptions.Builder

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
Returns
Type Description
GrpcStorageOptions.Builder

the builder

setTransportOptions(TransportOptions transportOptions)

public GrpcStorageOptions.Builder setTransportOptions(TransportOptions transportOptions)
Parameter
Name Description
transportOptions com.google.cloud.TransportOptions
Returns
Type Description
GrpcStorageOptions.Builder
Overrides
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)