Class GrpcStorageOptions.Builder (2.38.0)

Version latest

• 2.38.0 (latest)
• 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

Beta

This library 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.

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

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.

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

setAttemptDirectPath(boolean attemptDirectPath)

public GrpcStorageOptions.Builder setAttemptDirectPath(boolean attemptDirectPath)

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

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

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

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
credentials	com.google.auth.Credentials

Returns
Type	Description
GrpcStorageOptions.Builder

Overrides

com.google.cloud.ServiceOptions.Builder.setCredentials(com.google.auth.Credentials)

setGrpcInterceptorProvider(@NonNull GrpcInterceptorProvider grpcInterceptorProvider)

public GrpcStorageOptions.Builder setGrpcInterceptorProvider(@NonNull GrpcInterceptorProvider grpcInterceptorProvider)

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

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

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

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

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

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

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

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

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.

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)

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 maximum duration in which to await termination of any outstanding requests when calling Storage#close()

Parameter
Name	Description
terminationAwaitDuration	org.threeten.bp.Duration a non-null Duration to use

Returns
Type	Description
GrpcStorageOptions.Builder	the builder

setTransportOptions(TransportOptions transportOptions)

public GrpcStorageOptions.Builder setTransportOptions(TransportOptions transportOptions)

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
transportOptions	com.google.cloud.TransportOptions

Returns
Type	Description
GrpcStorageOptions.Builder

Overrides

com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)