Class GrpcStorageOptions.Builder (2.59.0)

Version latest

• 2.59.0 (latest)
• 2.58.1
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.3
• 2.52.3
• 2.50.0
• 2.49.0
• 2.48.2
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public static final class GrpcStorageOptions.Builder extends StorageOptions.Builder

Inheritance

java.lang.Object > com.google.cloud.ServiceOptions.Builder > StorageOptions.Builder > GrpcStorageOptions.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)

StorageOptions.Builder.build()

StorageOptions.Builder.setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig)

StorageOptions.Builder.setOpenTelemetry(OpenTelemetry)

StorageOptions.Builder.setStorageRetryStrategy(StorageRetryStrategy)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public GrpcStorageOptions build()

Returns
Type	Description
GrpcStorageOptions

Overrides

StorageOptions.Builder.build()

self()

protected GrpcStorageOptions.Builder self()

Returns
Type	Description
GrpcStorageOptions.Builder

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.

Parameter
Name	Description
apiTracerFactory	ApiTracerFactory

Returns
Type	Description
GrpcStorageOptions.Builder

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.

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)

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.

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

StorageOptions.Builder.setBlobWriteSessionConfig(@NonNull BlobWriteSessionConfig blobWriteSessionConfig)

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)

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

Returns
Type	Description
GrpcStorageOptions.Builder

Overrides

StorageOptions.Builder.setOpenTelemetry(OpenTelemetry openTelemetry)

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

StorageOptions.Builder.setStorageRetryStrategy(StorageRetryStrategy storageRetryStrategy)

setTerminationAwaitDuration(Duration terminationAwaitDuration)

public GrpcStorageOptions.Builder setTerminationAwaitDuration(Duration terminationAwaitDuration)

Obsolete

Use setTerminationAwaitJavaTimeDuration(java.time.Duration) instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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)

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

Returns
Type	Description
GrpcStorageOptions.Builder

Overrides

com.google.cloud.ServiceOptions.Builder.setUniverseDomain(java.lang.String)