Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::OAuthToken.
Contains information needed for generating an
OAuth token.
This type of authorization should generally only be used when calling Google
APIs hosted on *.googleapis.com.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#scope
defscope()->::String
Returns
(::String) — OAuth scope to be used for generating OAuth access token.
If not specified, "https://www.googleapis.com/auth/cloud-platform"
will be used.
#scope=
defscope=(value)->::String
Parameter
value (::String) — OAuth scope to be used for generating OAuth access token.
If not specified, "https://www.googleapis.com/auth/cloud-platform"
will be used.
Returns
(::String) — OAuth scope to be used for generating OAuth access token.
If not specified, "https://www.googleapis.com/auth/cloud-platform"
will be used.
#service_account_email
defservice_account_email()->::String
Returns
(::String) — Service account email
to be used for generating OAuth token.
The service account must be within the same project as the queue. The
caller must have iam.serviceAccounts.actAs permission for the service
account.
#service_account_email=
defservice_account_email=(value)->::String
Parameter
value (::String) — Service account email
to be used for generating OAuth token.
The service account must be within the same project as the queue. The
caller must have iam.serviceAccounts.actAs permission for the service
account.
Returns
(::String) — Service account email
to be used for generating OAuth token.
The service account must be within the same project as the queue. The
caller must have iam.serviceAccounts.actAs permission for the service
account.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::OAuthToken (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-tasks-v2/latest/Google-Cloud-Tasks-V2-OAuthToken)\n- [1.2.1](/ruby/docs/reference/google-cloud-tasks-v2/1.2.1/Google-Cloud-Tasks-V2-OAuthToken)\n- [1.1.0](/ruby/docs/reference/google-cloud-tasks-v2/1.1.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [1.0.1](/ruby/docs/reference/google-cloud-tasks-v2/1.0.1/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.11.0](/ruby/docs/reference/google-cloud-tasks-v2/0.11.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.10.2](/ruby/docs/reference/google-cloud-tasks-v2/0.10.2/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.9.0](/ruby/docs/reference/google-cloud-tasks-v2/0.9.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.8.2](/ruby/docs/reference/google-cloud-tasks-v2/0.8.2/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.7.0](/ruby/docs/reference/google-cloud-tasks-v2/0.7.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.6.0](/ruby/docs/reference/google-cloud-tasks-v2/0.6.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.5.0](/ruby/docs/reference/google-cloud-tasks-v2/0.5.0/Google-Cloud-Tasks-V2-OAuthToken)\n- [0.4.6](/ruby/docs/reference/google-cloud-tasks-v2/0.4.6/Google-Cloud-Tasks-V2-OAuthToken) \nReference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::OAuthToken.\n\nContains information needed for generating an\n[OAuth token](https://developers.google.com/identity/protocols/OAuth2).\nThis type of authorization should generally only be used when calling Google\nAPIs hosted on \\*.googleapis.com. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #scope\n\n def scope() -\u003e ::String\n\n**Returns**\n\n- (::String) --- OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used.\n\n### #scope=\n\n def scope=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used. \n**Returns**\n\n- (::String) --- OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used.\n\n### #service_account_email\n\n def service_account_email() -\u003e ::String\n\n**Returns**\n\n- (::String) --- [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.\n\n### #service_account_email=\n\n def service_account_email=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. \n**Returns**\n\n- (::String) --- [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account."]]
