Class: Google::Apis::CesV1::OAuthConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

Configurations for authentication with OAuth.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OAuthConfig

Returns a new instance of OAuthConfig.



4941
4942
4943
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4941

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#client_id ⇒ String

Required. The client ID from the OAuth provider. Corresponds to the JSON property clientId

Returns:

  • (String) 


4915
4916
4917
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4915

def client_id
  @client_id
end

#client_secret_version ⇒ String

Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/project/secrets/secret/versions/version` Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. Corresponds to the JSON propertyclientSecretVersion`

Returns:

  • (String) 


4923
4924
4925
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4923

def client_secret_version
  @client_secret_version
end

#oauth_grant_type ⇒ String

Required. OAuth grant types. Corresponds to the JSON property oauthGrantType

Returns:

  • (String) 


4928
4929
4930
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4928

def oauth_grant_type
  @oauth_grant_type
end

#scopes ⇒ Array<String>

Optional. The OAuth scopes to grant. Corresponds to the JSON property scopes

Returns:

  • (Array<String>) 


4933
4934
4935
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4933

def scopes
  @scopes
end

#token_endpoint ⇒ String

Required. The token endpoint in the OAuth provider to exchange for an access token. Corresponds to the JSON property tokenEndpoint

Returns:

  • (String) 


4939
4940
4941
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4939

def token_endpoint
  @token_endpoint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4946
4947
4948
4949
4950
4951
4952
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4946

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @client_secret_version = args[:client_secret_version] if args.key?(:client_secret_version)
  @oauth_grant_type = args[:oauth_grant_type] if args.key?(:oauth_grant_type)
  @scopes = args[:scopes] if args.key?(:scopes)
  @token_endpoint = args[:token_endpoint] if args.key?(:token_endpoint)
end