google::cloud::storage::ClientOptions Class Reference

Describes the configuration for a storage::Client object. More...

#include <google/cloud/storage/client_options.h>

Public Member Functions
	ClientOptions (std::shared_ptr< oauth2::Credentials > credentials)
	Constructor with channel options. More...
	ClientOptions (std::shared_ptr< oauth2::Credentials > credentials, ChannelOptions channel_options)
	Constructor with channel options. More...
std::shared_ptr< oauth2::Credentials >	credentials () const
ClientOptions &	set_credentials (std::shared_ptr< oauth2::Credentials > c)
std::string const &	endpoint () const
ClientOptions &	set_endpoint (std::string endpoint)
std::string const &	iam_endpoint () const
ClientOptions &	set_iam_endpoint (std::string endpoint)
std::string const &	version () const
ClientOptions &	set_version (std::string version)
bool	enable_http_tracing () const
ClientOptions &	set_enable_http_tracing (bool enable)
bool	enable_raw_client_tracing () const
ClientOptions &	set_enable_raw_client_tracing (bool enable)
std::string const &	project_id () const
ClientOptions &	set_project_id (std::string v)
std::size_t	connection_pool_size () const
ClientOptions &	set_connection_pool_size (std::size_t size)
std::size_t	download_buffer_size () const
ClientOptions &	SetDownloadBufferSize (std::size_t size)
std::size_t	upload_buffer_size () const
ClientOptions &	SetUploadBufferSize (std::size_t size)
std::string const &	user_agent_prefix () const
ClientOptions &	add_user_agent_prefix (std::string prefix)
ClientOptions &	add_user_agent_prefx (std::string const &v)
std::size_t	maximum_simple_upload_size () const
ClientOptions &	set_maximum_simple_upload_size (std::size_t v)
bool	enable_ssl_locking_callbacks () const
	If true and using OpenSSL 1.0.2 the library configures the OpenSSL callbacks for locking. More...
ClientOptions &	set_enable_ssl_locking_callbacks (bool v)
	If true and using OpenSSL 1.0.2 the library configures the OpenSSL callbacks for locking. More...
bool	enable_sigpipe_handler () const
ClientOptions &	set_enable_sigpipe_handler (bool v)
std::size_t	maximum_socket_recv_size () const
ClientOptions &	set_maximum_socket_recv_size (std::size_t v)
std::size_t	maximum_socket_send_size () const
ClientOptions &	set_maximum_socket_send_size (std::size_t v)
ChannelOptions &	channel_options ()
ChannelOptions const &	channel_options () const
std::chrono::seconds	download_stall_timeout () const
	Control the maximum amount of time allowed for "stalls" during a download. More...
ClientOptions &	set_download_stall_timeout (std::chrono::seconds v)

Static Public Member Functions
static StatusOr< ClientOptions >	CreateDefaultClientOptions ()
	Creates a ClientOptions with Google Application Default Credentials. More...
static StatusOr< ClientOptions >	CreateDefaultClientOptions (ChannelOptions const &channel_options)

Detailed Description

Describes the configuration for a storage::Client object.

By default, several environment variables are read to configure the client:

• CLOUD_STORAGE_EMULATOR_ENDPOINT: if set, use this http endpoint to make all http requests instead of the production GCS service. Also, if set, the CreateDefaultClientOptions() function will use an AnonymousCredentials object instead of loading Application Default Credentials.
• CLOUD_STORAGE_ENABLE_CLOG: if set, enable std::clog as a backend for google::cloud::LogSink.

• CLOUD_STORAGE_ENABLE_TRACING: if set, this is the list of components that will have logging enabled, the component this is:

  • http: trace all http request / responses.

  Deprecated:

  Please use google::cloud::Options instead.

Constructor & Destructor Documentation

ClientOptions() [1/2]

google::cloud::storage::ClientOptions::ClientOptions ( std::shared_ptr< oauth2::Credentials >  credentials )

inlineexplicit

Constructor with channel options.

Deprecated:

use google::cloud::Options instead.

Parameters

credentials

how to authenticate to the client. Using a nullptr for credentials results in undefined behavior.

ClientOptions() [2/2]

google::cloud::storage::ClientOptions::ClientOptions	(	std::shared_ptr< oauth2::Credentials >	credentials,
		ChannelOptions	channel_options
	)

Constructor with channel options.

Deprecated:

use google::cloud::Options instead.

Parameters

credentials	how to authenticate to the client. Using a nullptr for credentials results in undefined behavior.
channel_options	the configuration for SSL certificate validation.

Member Function Documentation

add_user_agent_prefix()

ClientOptions & google::cloud::storage::ClientOptions::add_user_agent_prefix ( std::string  prefix )

inline

Deprecated:

Use google::cloud::Options and google::cloud::UserAgentProductsOption instead.

add_user_agent_prefx()

ClientOptions & google::cloud::storage::ClientOptions::add_user_agent_prefx ( std::string const &  v )

inline

Deprecated:

use add_user_agent_prefix() instead.

channel_options() [1/2]

ChannelOptions & google::cloud::storage::ClientOptions::channel_options ( )

inline

Deprecated:

Use google::cloud::Options and CAPathOption instead.

channel_options() [2/2]

ChannelOptions const & google::cloud::storage::ClientOptions::channel_options ( ) const

inline

Deprecated:

Use google::cloud::Options and CAPathOption instead.

connection_pool_size()

std::size_t google::cloud::storage::ClientOptions::connection_pool_size ( ) const

inline

Deprecated:

Use google::cloud::Options and ConnectionPoolSizeOption instead.

CreateDefaultClientOptions() [1/2]

static StatusOr< ClientOptions > google::cloud::storage::ClientOptions::CreateDefaultClientOptions ( )

static

Creates a ClientOptions with Google Application Default Credentials.

If Application Default Credentials could not be loaded, this returns a Status with failure details. If the CLOUD_STORAGE_EMULATOR_ENDPOINT environment variable is set, this function instead uses an AnonymousCredentials to configure the client.

Deprecated:

Please use google::cloud::Options instead.

CreateDefaultClientOptions() [2/2]

static StatusOr< ClientOptions > google::cloud::storage::ClientOptions::CreateDefaultClientOptions ( ChannelOptions const &  channel_options )

static

Deprecated:

Please use google::cloud::Options instead.

credentials()

std::shared_ptr< oauth2::Credentials > google::cloud::storage::ClientOptions::credentials ( ) const

inline

Deprecated:

Use google::cloud::Options and Oauth2CredentialsOption instead.

download_buffer_size()

std::size_t google::cloud::storage::ClientOptions::download_buffer_size ( ) const

inline

Deprecated:

Use google::cloud::Options and DownloadBufferSizeOption instead.

download_stall_timeout()

std::chrono::seconds google::cloud::storage::ClientOptions::download_stall_timeout ( ) const

inline

Control the maximum amount of time allowed for "stalls" during a download.

A download that receives no data is considered "stalled". If the download remains stalled for more than the time set in this option then the download is aborted.

The default value is 2 minutes. Can be disabled by setting the value to 0.

Deprecated:

Use google::cloud::Options and DownloadStallTimeoutOption instead.

enable_http_tracing()

bool google::cloud::storage::ClientOptions::enable_http_tracing

(

)

const

Deprecated:

Use google::cloud::Options and google::cloud::TracingComponentsOption instead.

enable_raw_client_tracing()

bool google::cloud::storage::ClientOptions::enable_raw_client_tracing

(

)

const

Deprecated:

Use google::cloud::Options and google::cloud::TracingComponentsOption instead.

enable_sigpipe_handler()

bool google::cloud::storage::ClientOptions::enable_sigpipe_handler ( ) const

inline

Deprecated:

Use google::cloud::Options and EnableCurlSigpipeOption instead.

enable_ssl_locking_callbacks()

bool google::cloud::storage::ClientOptions::enable_ssl_locking_callbacks ( ) const

inline

If true and using OpenSSL 1.0.2 the library configures the OpenSSL callbacks for locking.

Deprecated:

Use google::cloud::options and EnableCurlSslLockingOption instead.

endpoint()

std::string const & google::cloud::storage::ClientOptions::endpoint ( ) const

inline

Deprecated:

Use google::cloud::Options and RestEndpointOption instead.

iam_endpoint()

std::string const & google::cloud::storage::ClientOptions::iam_endpoint ( ) const

inline

Deprecated:

Use google::cloud::Options and IamEndpointOption instead.

maximum_simple_upload_size()

std::size_t google::cloud::storage::ClientOptions::maximum_simple_upload_size ( ) const

inline

Deprecated:

Use google::cloud::Options and MaximumSimpleUploadSizeOption instead.

maximum_socket_recv_size()

std::size_t google::cloud::storage::ClientOptions::maximum_socket_recv_size ( ) const

inline

Deprecated:

Use google::cloud::Options and MaximumCurlSocketRecvSizeOption instead.

maximum_socket_send_size()

std::size_t google::cloud::storage::ClientOptions::maximum_socket_send_size ( ) const

inline

Deprecated:

Use google::cloud::Options and MaximumCurlSocketSendSizeOption instead.

project_id()

std::string const & google::cloud::storage::ClientOptions::project_id ( ) const

inline

Deprecated:

Use google::cloud::Options and ProjectIdOption instead.

set_connection_pool_size()

ClientOptions & google::cloud::storage::ClientOptions::set_connection_pool_size ( std::size_t  size )

inline

Deprecated:

Use google::cloud::Options and ConnectionPoolSizeOption instead.

set_credentials()

ClientOptions & google::cloud::storage::ClientOptions::set_credentials ( std::shared_ptr< oauth2::Credentials >  c )

inline

Deprecated:

Use google::cloud::Options and Oauth2CredentialsOption instead.

set_download_stall_timeout()

ClientOptions & google::cloud::storage::ClientOptions::set_download_stall_timeout ( std::chrono::seconds  v )

inline

Deprecated:

Use google::cloud::Options and DownloadStallTimeoutOption instead.

set_enable_http_tracing()

ClientOptions & google::cloud::storage::ClientOptions::set_enable_http_tracing

(

bool

enable

)

Deprecated:

Use google::cloud::Options and google::cloud::TracingComponentsOption instead.

set_enable_raw_client_tracing()

ClientOptions & google::cloud::storage::ClientOptions::set_enable_raw_client_tracing

(

bool

enable

)

Deprecated:

Use google::cloud::Options and google::cloud::TracingComponentsOption instead.

set_enable_sigpipe_handler()

ClientOptions & google::cloud::storage::ClientOptions::set_enable_sigpipe_handler ( bool  v )

inline

Deprecated:

Use google::cloud::Options and EnableCurlSigpipeOption instead.

set_enable_ssl_locking_callbacks()

ClientOptions & google::cloud::storage::ClientOptions::set_enable_ssl_locking_callbacks ( bool  v )

inline

If true and using OpenSSL 1.0.2 the library configures the OpenSSL callbacks for locking.

Deprecated:

Use google::cloud::options and EnableCurlSslLockingOption instead.

set_endpoint()

ClientOptions & google::cloud::storage::ClientOptions::set_endpoint ( std::string  endpoint )

inline

Deprecated:

Use google::cloud::Options and RestEndpointOption instead.

set_iam_endpoint()

ClientOptions & google::cloud::storage::ClientOptions::set_iam_endpoint ( std::string  endpoint )

inline

Deprecated:

Use google::cloud::Options and IamEndpointOption instead.

set_maximum_simple_upload_size()

ClientOptions & google::cloud::storage::ClientOptions::set_maximum_simple_upload_size ( std::size_t  v )

inline

Deprecated:

Use google::cloud::Options and MaximumSimpleUploadSizeOption instead.

set_maximum_socket_recv_size()

ClientOptions & google::cloud::storage::ClientOptions::set_maximum_socket_recv_size ( std::size_t  v )

inline

Deprecated:

Use google::cloud::Options and MaximumCurlSocketRecvSizeOption instead.

set_maximum_socket_send_size()

ClientOptions & google::cloud::storage::ClientOptions::set_maximum_socket_send_size ( std::size_t  v )

inline

Deprecated:

Use google::cloud::Options and MaximumCurlSocketSendSizeOption instead.

set_project_id()

ClientOptions & google::cloud::storage::ClientOptions::set_project_id ( std::string  v )

inline

Deprecated:

Use google::cloud::Options and ProjectIdOption instead.

set_version()

ClientOptions & google::cloud::storage::ClientOptions::set_version ( std::string  version )

inline

Deprecated:

This was intended for development and not a public API.

SetDownloadBufferSize()

ClientOptions & google::cloud::storage::ClientOptions::SetDownloadBufferSize

(

std::size_t

size

)

Deprecated:

Use google::cloud::Options and DownloadBufferSizeOption instead.

SetUploadBufferSize()

ClientOptions & google::cloud::storage::ClientOptions::SetUploadBufferSize

(

std::size_t

size

)

Deprecated:

Use google::cloud::Options and UploadBufferSizeOption instead.

upload_buffer_size()

std::size_t google::cloud::storage::ClientOptions::upload_buffer_size ( ) const

inline

Deprecated:

Use google::cloud::Options and UploadBufferSizeOption instead.

user_agent_prefix()

std::string const & google::cloud::storage::ClientOptions::user_agent_prefix ( ) const

inline

Deprecated:

Use google::cloud::Options and google::cloud::UserAgentProductsOption instead.

version()

std::string const & google::cloud::storage::ClientOptions::version ( ) const

inline

Deprecated:

This was intended for development and not a public API.