framework.infrastructure.gcp.api.GcpApiManager Class Reference

Public Member Functions
def	__init__ (self, *v1_discovery_uri=None, v2_discovery_uri=None, compute_v1_discovery_file=None, private_api_key_secret_name=None, gcp_ui_url=None)
def	close (self)
def	compute (self, version)
discovery.Resource	iam (self, str version)
def	networksecurity (self, version)
def	networkservices (self, version)
def	private_api_key (self)

Static Public Member Functions
def	secrets (str version)

Public Attributes
	compute_v1_discovery_file
	gcp_ui_url
	private_api_key_secret_name
	v1_discovery_uri
	v2_discovery_uri

Private Member Functions
def	_build_from_discovery_v1 (self, api_name, version)
def	_build_from_discovery_v2 (self, api_name, version, *Optional[str] api_key=None, Optional[List] visibility_labels=None)
def	_build_from_file (self, discovery_file)

Private Attributes
	_exit_stack

Detailed Description

Definition at line 64 of file api.py.

Constructor & Destructor Documentation

__init__()

def framework.infrastructure.gcp.api.GcpApiManager.__init__	(		self,
		*	v1_discovery_uri = None,
			v2_discovery_uri = None,
			compute_v1_discovery_file = None,
			private_api_key_secret_name = None,
			gcp_ui_url = None
	)

Definition at line 66 of file api.py.

Member Function Documentation

_build_from_discovery_v1()

def framework.infrastructure.gcp.api.GcpApiManager._build_from_discovery_v1 (   self,   api_name,   version  )

private

Definition at line 174 of file api.py.

_build_from_discovery_v2()

def framework.infrastructure.gcp.api.GcpApiManager._build_from_discovery_v2 (   self,   api_name,   version, *Optional[str]   api_key = None, Optional[List]   visibility_labels = None  )

private

Definition at line 182 of file api.py.

_build_from_file()

def framework.infrastructure.gcp.api.GcpApiManager._build_from_file (   self,   discovery_file  )

private

Definition at line 207 of file api.py.

close()

def framework.infrastructure.gcp.api.GcpApiManager.close

(

self

)

Definition at line 83 of file api.py.

compute()

def framework.infrastructure.gcp.api.GcpApiManager.compute	(		self,
			version
	)

Definition at line 112 of file api.py.

iam()

discovery.Resource framework.infrastructure.gcp.api.GcpApiManager.iam	(		self,
		str	version
	)

Identity and Access Management (IAM) API.

https://cloud.google.com/iam/docs/reference/rest
https://googleapis.github.io/google-api-python-client/docs/dyn/iam_v1.html

Definition at line 161 of file api.py.

networksecurity()

def framework.infrastructure.gcp.api.GcpApiManager.networksecurity	(		self,
			version
	)

Definition at line 125 of file api.py.

networkservices()

def framework.infrastructure.gcp.api.GcpApiManager.networkservices	(		self,
			version
	)

Definition at line 139 of file api.py.

private_api_key()

def framework.infrastructure.gcp.api.GcpApiManager.private_api_key

(

self

)

Private API key.

Return API key credential that identifies a GCP project allow-listed for
accessing private API discovery documents.
https://console.cloud.google.com/apis/credentials

This method lazy-loads the content of the key from the Secret Manager.
https://console.cloud.google.com/security/secret-manager

Definition at line 88 of file api.py.

secrets()

def framework.infrastructure.gcp.api.GcpApiManager.secrets ( str  version )

static

Definition at line 154 of file api.py.

Member Data Documentation

_exit_stack

framework.infrastructure.gcp.api.GcpApiManager._exit_stack

private

Definition at line 75 of file api.py.

compute_v1_discovery_file

framework.infrastructure.gcp.api.GcpApiManager.compute_v1_discovery_file

Definition at line 69 of file api.py.

gcp_ui_url

framework.infrastructure.gcp.api.GcpApiManager.gcp_ui_url

Definition at line 73 of file api.py.

private_api_key_secret_name

framework.infrastructure.gcp.api.GcpApiManager.private_api_key_secret_name

Definition at line 71 of file api.py.

v1_discovery_uri

framework.infrastructure.gcp.api.GcpApiManager.v1_discovery_uri

Definition at line 67 of file api.py.

v2_discovery_uri

framework.infrastructure.gcp.api.GcpApiManager.v2_discovery_uri

Definition at line 68 of file api.py.

---

The documentation for this class was generated from the following file:

• api.py