Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::OAuthConfig (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::OAuthConfig.

Configurations for authentication with OAuth.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#client_id

def client_id() -> ::String
Returns
  • (::String) — Required. The client ID from the OAuth provider.

#client_id=

def client_id=(value) -> ::String
Parameter
  • value (::String) — Required. The client ID from the OAuth provider.
Returns
  • (::String) — Required. The client ID from the OAuth provider.

#client_secret_version

def client_secret_version() -> ::String
Returns
  • (::String) — Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

#client_secret_version=

def client_secret_version=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Returns
  • (::String) — Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

#oauth_grant_type

def oauth_grant_type() -> ::Google::Cloud::Ces::V1::OAuthConfig::OauthGrantType
Returns

#oauth_grant_type=

def oauth_grant_type=(value) -> ::Google::Cloud::Ces::V1::OAuthConfig::OauthGrantType
Parameter
Returns

#scopes

def scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The OAuth scopes to grant.

#scopes=

def scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The OAuth scopes to grant.
Returns
  • (::Array<::String>) — Optional. The OAuth scopes to grant.

#token_endpoint

def token_endpoint() -> ::String
Returns
  • (::String) — Required. The token endpoint in the OAuth provider to exchange for an access token.

#token_endpoint=

def token_endpoint=(value) -> ::String
Parameter
  • value (::String) — Required. The token endpoint in the OAuth provider to exchange for an access token.
Returns
  • (::String) — Required. The token endpoint in the OAuth provider to exchange for an access token.