Client Options¶

Client options class.

Client options provide a consistent interface for user options to be definedacross clients.

You can pass a client options object to a client.

fromgoogle.api_core.client_optionsimportClientOptionsfromgoogle.cloud.vision_v1importImageAnnotatorClientdefget_client_cert():# code to load client certificate and private key.returnclient_cert_bytes,client_private_key_bytesoptions=ClientOptions(api_endpoint="foo.googleapis.com",client_cert_source=get_client_cert)client=ImageAnnotatorClient(client_options=options)

You can also pass a mapping object.

fromgoogle.cloud.vision_v1importImageAnnotatorClientclient=ImageAnnotatorClient(client_options={"api_endpoint":"foo.googleapis.com","client_cert_source":get_client_cert})

classgoogle.api_core.client_options.ClientOptions(api_endpoint:Optional[str]=None,client_cert_source:Optional[Callable[[],Tuple[bytes,bytes]]]=None,client_encrypted_cert_source:Optional[Callable[[],Tuple[str,str,bytes]]]=None,quota_project_id:Optional[str]=None,credentials_file:Optional[str]=None,scopes:Optional[Sequence[str]]=None,api_key:Optional[str]=None,api_audience:Optional[str]=None,universe_domain:Optional[str]=None)[source]¶

Bases:object

Client Options used to set options on clients.

Parameters

• api_endpoint (Optional[str]) – The desired API endpoint, e.g.,compute.googleapis.com

• client_cert_source (Optional[Callable[[],Tuple[bytes,bytes]]]) – A callbackwhich returns client certificate bytes and private key bytes both inPEM format.client_cert_source andclient_encrypted_cert_sourceare mutually exclusive.

• client_encrypted_cert_source (Optional[Callable[[],Tuple[str,str,bytes]]]) – A callback which returns client certificate file path, encryptedprivate key file path, and the passphrase bytes.``client_cert_source``andclient_encrypted_cert_source are mutually exclusive.

• quota_project_id (Optional[str]) – A project name that a client’squota belongs to.

• credentials_file (Optional[str]) –

  Deprecated. A path to a file storing credentials.credentials_file`and``api_key are mutually exclusive. This argument will beremoved in the next major version ofgoogle-api-core.

  Warning

  Important: If you accept a credential configuration (credential JSON/File/Stream)from an external source for authentication to Google Cloud Platform, you mustvalidate it before providing it to any Google API or client library. Providing anunvalidated credential configuration to Google APIs or libraries can compromisethe security of your systems and data. For more information, refer toValidate credential configurations from external sources.

  https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

• scopes (Optional[Sequence[str]]) – OAuth access token override scopes.

• api_key (Optional[str]) – Google API key.credentials_file andapi_key are mutually exclusive.

• api_audience (Optional[str]) – The intended audience for the API callsto the service that will be set when using certain 3rd partyauthentication flows. Audience is typically a resource identifier.If not set, the service endpoint value will be used as a default.An example of a validapi_audience is: “https://language.googleapis.com”.

• universe_domain (Optional[str]) – The desired universe domain. This must matchthe one in credentials. If not set, the default universe domain isgoogleapis.com. If bothapi_endpoint anduniverse_domain are set,thenapi_endpoint is used as the service endpoint. Ifapi_endpoint isnot specified, the format will be{service}.{universe_domain}.

Raises

ValueError – If bothclient_cert_source andclient_encrypted_cert_source are provided, or bothcredentials_file andapi_key are provided.

google.api_core.client_options.from_dict(options:Mapping[str,object])→google.api_core.client_options.ClientOptions[source]¶

Construct a client options object from a mapping object.

Parameters

options (collections.abc.Mapping) – A mapping object with client options.See the docstring for ClientOptions for details on valid arguments.