Class: Google::Apis::CloudschedulerV1::OAuthToken

Inherits:

Object

• Object
• Google::Apis::CloudschedulerV1::OAuthToken

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

generated/google/apis/cloudscheduler_v1/classes.rb,
generated/google/apis/cloudscheduler_v1/representations.rb,
generated/google/apis/cloudscheduler_v1/representations.rb

Overview

Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint.

Instance Attribute Summary

• #scope ⇒ String

  OAuth scope to be used for generating OAuth access token.

• #service_account_email ⇒ String

  Service account email to be used for generating OAuth token.

Instance Method Summary

• #initialize(**args) ⇒ OAuthToken constructor

  A new instance of OAuthToken.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OAuthToken

Returns a new instance of OAuthToken

# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 661

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

Instance Attribute Details

#scope ⇒ String

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. Corresponds to the JSON property scope

Returns:

• (String)

# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 651

def scope
  @scope
end

#service_account_email ⇒ String

Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. Corresponds to the JSON property serviceAccountEmail

Returns:

• (String)

# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 659

def service_account_email
  @service_account_email
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 666

def update!(**args)
  @scope = args[:scope] if args.key?(:scope)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
end