GceToken: Token for use on Google Compute Engine instances

In r-lib/gargle: Utilities for Working with Google APIs

Token for use on Google Compute Engine instances

Description

Token for use on Google Compute Engine instances

Token for use on Google Compute Engine instances

Details

This class uses the metadata service available on GCE VMs to fetch access tokens. Not intended for direct use. See credentials_gce() instead.

Super classes

httr::Token -> httr::Token2.0 -> GceToken

Methods

Public methods

• GceToken$new()

• GceToken$init_credentials()

• GceToken$refresh()

• GceToken$can_refresh()

• GceToken$format()

• GceToken$print()

• GceToken$cache()

• GceToken$load_from_cache()

• GceToken$revoke()

• GceToken$validate()

• GceToken$clone()

Inherited methods

• httr::Token$hash()
• httr::Token2.0$sign()

---

Method new()

Get an access for a GCE service account.

Usage

GceToken$new(params)

Arguments

params

A list of parameters for fetch_gce_access_token().

Returns

A GceToken.

---

Method init_credentials()

Request an access token.

Usage

GceToken$init_credentials()

---

Method refresh()

Refreshes the token. In this case, that just means "ask again for an access token".

Usage

GceToken$refresh()

---

Method can_refresh()

Placeholder implementation of required method. Returns TRUE.

Usage

GceToken$can_refresh()

---

Method format()

Format a GceToken().

Usage

GceToken$format(...)

Arguments

...

Not used.

---

Method print()

Print a GceToken().

Usage

GceToken$print(...)

Arguments

...

Not used.

---

Method cache()

Placeholder implementation of required method.

Usage

GceToken$cache()

---

Method load_from_cache()

Placeholder implementation of required method.

Usage

GceToken$load_from_cache()

---

Method revoke()

Placeholder implementation of required method.

Usage

GceToken$revoke()

---

Method validate()

Placeholder implementation of required method

Usage

GceToken$validate()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GceToken$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

r-lib/gargle documentation built on Sept. 10, 2023, 10:38 a.m.