Crawler implementation for gcp resources.
AppEngineApp
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for AppEngine App.
AppEngineAppIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for AppEngineApp
AppEngineInstance
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for AppEngine Instance.
AppEngineInstanceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for AppEngineInstance
AppEngineService
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for AppEngine Service.
AppEngineServiceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for AppEngineService
AppEngineVersion
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for AppEngine Version.
AppEngineVersionIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for AppEngineVersion
BigqueryDataSet
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Bigquery DataSet.
_set_cache
(field_name, value)[source]¶Manually set a cache value if it isn’t already set.
Parameters: |
|
---|
BigqueryDataSetIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Bigquery Dataset.
BigqueryTable
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for bigquery table.
BigqueryTableIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Bigquery Table.
BillingAccount
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for BillingAccount.
BillingAccountIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Billing Account.
CloudSqlInstance
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for CloudSQL Instance.
CloudSqlInstanceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for CloudSQL Instance.
CompositeRootIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The resource iterator for the fake composite root resource.
CompositeRootResource
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Composite Root fake resource.
create
(composite_root_resources)[source]¶Creates a new composite root.
Parameters: | composite_root_resources (list) – The list of resources to crawl using a composite root. |
---|---|
Returns: |
|
Return type: | CompositeRootResource |
ComputeAutoscaler
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Autoscaler.
ComputeAutoscalerIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Autoscaler.
ComputeBackendBucket
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Backend Bucket.
ComputeBackendBucketIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute BackendBucket.
ComputeBackendService
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Backend Service.
ComputeBackendServiceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute BackendService.
ComputeDisk
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Disk.
ComputeDiskIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Disk.
ComputeFirewall
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Firewall.
ComputeFirewallIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Firewall.
ComputeForwardingRule
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Forwarding Rule.
ComputeForwardingRuleIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute ForwardingRule.
ComputeHealthCheck
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute HealthCheck.
ComputeHealthCheckIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute HealthCheck.
ComputeHttpHealthCheck
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute HTTP HealthCheck.
ComputeHttpHealthCheckIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute HttpHealthCheck.
ComputeHttpsHealthCheck
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute HTTPS HealthCheck.
ComputeHttpsHealthCheckIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute HttpsHealthCheck.
ComputeImage
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Image.
ComputeImageIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Image.
ComputeInstance
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Instance.
ComputeInstanceGroup
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute InstanceGroup.
ComputeInstanceGroupIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Compute InstanceGroup.
ComputeInstanceGroupManager
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute InstanceGroupManager.
ComputeInstanceGroupManagerIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute InstanceGroupManager.
ComputeInstanceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Instance.
ComputeInstanceTemplate
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute InstanceTemplate.
ComputeInstanceTemplateIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute InstanceTemplate.
ComputeLicense
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute License.
ComputeLicenseIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute License.
ComputeNetwork
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Network.
ComputeNetworkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Network.
ComputeProject
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Project.
ComputeProjectIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Project.
ComputeRouter
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Router.
ComputeRouterIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Router.
ComputeSnapshot
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Snapshot.
ComputeSnapshotIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Snapshot.
ComputeSslCertificate
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute SSL Certificate.
ComputeSslCertificateIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute SSL Certificate.
ComputeSubnetwork
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute Subnetwork.
ComputeSubnetworkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute Subnetwork.
ComputeTargetHttpProxy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetHttpProxy.
ComputeTargetHttpProxyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetHttpProxy.
ComputeTargetHttpsProxy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetHttpsProxy.
ComputeTargetHttpsProxyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetHttpsProxy.
ComputeTargetInstance
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetInstance.
ComputeTargetInstanceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetInstance.
ComputeTargetPool
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetPool.
ComputeTargetPoolIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetPool.
ComputeTargetSslProxy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetSslProxy.
ComputeTargetSslProxyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetSslProxy.
ComputeTargetTcpProxy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetTcpProxy.
ComputeTargetTcpProxyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetTcpProxy.
ComputeTargetVpnGateway
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute TargetVpnGateway.
ComputeTargetVpnGatewayIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute TargetVpnGateway.
ComputeUrlMap
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute UrlMap.
ComputeUrlMapIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute UrlMap.
ComputeVpnTunnel
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Compute VpnTunnel.
ComputeVpnTunnelIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Compute VpnTunnel.
DataprocCluster
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Dataproc Cluster.
DataprocClusterIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Cloud Dataproc Cluster.
DnsManagedZone
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Cloud DNS ManagedZone.
DnsManagedZoneIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Cloud DNS ManagedZone.
DnsPolicy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Cloud DNS Policy.
DnsPolicyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Cloud DNS Policy.
GsuiteGroup
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for GSuite User.
GsuiteGroupIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Gsuite Group
GsuiteGroupMember
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for GSuite User.
GsuiteGroupsSettings
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for GSuite Settings.
GsuiteGroupsSettingsIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Gsuite Group Settings
GsuiteMemberIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Gsuite Member
GsuiteUser
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for GSuite User.
GsuiteUserIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Gsuite User
GsuiteUserMember
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for GSuite User.
IamCuratedRole
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for IAM Curated Roles.
IamOrganizationCuratedRoleIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Organization Curated Role.
IamOrganizationRoleIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for IAM Organization Role.
IamProjectRoleIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for IAM Project Role.
IamRole
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for IAM Roles.
IamServiceAccount
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for IAM ServiceAccount.
IamServiceAccountIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for IAM ServiceAccount.
IamServiceAccountKey
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for IAM ServiceAccountKey.
IamServiceAccountKeyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for IAM ServiceAccount Key.
KmsCryptoKey
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for KMS CryptoKey.
KmsCryptoKeyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for KMS CryptoKey.
KmsCryptoKeyVersion
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for KMS CryptoKeyVersion.
KmsCryptoKeyVersionIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for KMS CryptoKeyVersion.
KmsKeyRing
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for KMS KeyRing.
KmsKeyRingIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for KMS KeyRing.
KubernetesCluster
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Kubernetes Cluster.
get_kubernetes_service_config
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
KubernetesClusterIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Kubernetes Cluster.
LoggingBillingAccountSinkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Logging Billing Account Sink.
LoggingFolderSinkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Logging Folder Sink.
LoggingOrganizationSinkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Logging Organization Sink
LoggingProjectSinkIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Logging Project Sink.
LoggingSink
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Stackdriver Logging sink.
PubsubSubscription
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for PubSub Subscription.
PubsubSubscriptionIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for PubSub Subscription.
PubsubTopic
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for PubSub Topic.
PubsubTopicIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for PubSub Topic.
Resource
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: object
The base Resource class.
__getitem__
(key)[source]¶Get Item.
Parameters: | key (str) – key of this resource. |
---|---|
Returns: | data of this resource. |
Return type: | str |
Raises: | KeyError – ‘key: {}, data: {}’ |
__setitem__
(key, value)[source]¶Set the value of an item.
Parameters: |
|
---|
_utcnow
()[source]¶Wrapper for datetime.datetime.now() injection.
Returns: | the datetime. |
---|---|
Return type: | datatime |
accept
(visitor, stack=None)[source]¶Accept of resource in visitor pattern.
Parameters: |
|
---|
add_warning
(warning)[source]¶Add warning on this resource.
Parameters: | warning (str) – warning to be added. |
---|
get_billing_info
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_cloudsql_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_dataset_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_enabled_apis
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_gcs_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_group_members
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_iam_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_kubernetes_service_config
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_timestamp
()[source]¶Template for timestamp when the resource object.
Returns: | a string timestamp when the resource object was created. |
---|---|
Return type: | str |
inventory_key
()[source]¶Gets the inventory key for this resource, if set.
Returns: | The unique id for the resource in storage. |
---|---|
Return type: | int |
metadata
()[source]¶Gets the asset metadata.
Returns: | Asset metadata. |
---|---|
Return type: | AssetMetadata |
parent
()[source]¶Get parent of this resource.
Returns: | parent of this resource. |
---|---|
Return type: | Resource |
set_inventory_key
(key)[source]¶Set the inventory unique id for the resource.
Parameters: | key (int) – The unique id for the resource from the storage. |
---|
should_dispatch
()[source]¶Whether resources should run in parallel threads.
Returns: | whether this resource should run in parallel threads. |
---|---|
Return type: | bool |
stack
()[source]¶Get resource hierarchy stack of this resource.
Returns: | resource hierarchy stack of this resource. |
---|---|
Return type: | list |
Raises: | Exception – ‘Stack not initialized yet’. |
try_accept
(visitor, stack=None)[source]¶Handle exceptions on the call the accept.
Parameters: |
|
---|
ResourceFactory
(attributes)[source]¶Bases: object
ResourceFactory for visitor pattern.
create_new
(data, root=False, metadata=None)[source]¶Create a new instance of a Resource type.
Parameters: |
|
---|---|
Returns: | Resource instance. |
Return type: |
ResourceManagerFolder
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Folder.
fetch
(client, resource_key, root=True)[source]¶Get Folder.
Parameters: |
|
---|---|
Returns: | Folder resource. |
Return type: |
ResourceManagerFolderIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Resource Manager Folder.
ResourceManagerFolderOrgPolicyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for CRM Folder Org Policies.
ResourceManagerLien
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Resource Manager Lien.
ResourceManagerOrgPolicy
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Resource Manager Organization Policy.
ResourceManagerOrganization
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Organization.
fetch
(client, resource_key, root=True)[source]¶Get Organization.
Saves ApiExecutionErrors as warnings.
Parameters: |
|
---|---|
Returns: | Organization resource. |
Return type: |
get_iam_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
ResourceManagerOrganizationOrgPolicyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator for CRM Organization Org Policies.
ResourceManagerProject
(data, root=False, contains=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Project.
bigquery_api_enabled
()[source]¶Check if the bigquery api is enabled.
Returns: | if this API service is enabled on the project. |
---|---|
Return type: | bool |
billing_enabled
()[source]¶Check if billing is configured.
Returns: | if billing is enabled on the project. |
---|---|
Return type: | bool |
compute_api_enabled
()[source]¶Check if the compute api is enabled.
Returns: | if this API service is enabled on the project. |
---|---|
Return type: | bool |
container_api_enabled
()[source]¶Check if the container api is enabled.
Returns: | if this API service is enabled on the project. |
---|---|
Return type: | bool |
enumerable
()[source]¶Check if this project is enumerable.
Returns: | if this project is enumerable. |
---|---|
Return type: | bool |
fetch
(client, resource_key, root=True)[source]¶Get Project.
Parameters: |
|
---|---|
Returns: | created project. |
Return type: |
get_billing_info
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_enabled_apis
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
get_iam_policy
(**kwargs)[source]¶Function wrapper to perform caching.
Parameters: |
|
---|---|
Returns: | Results of executing f. |
Return type: | object |
is_api_enabled
(service_name)[source]¶Returns True if the API service is enabled on the project.
Parameters: | service_name (str) – The API service name to check. |
---|---|
Returns: | whether a service api is enabled |
Return type: | bool |
ResourceManagerProjectIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIterator
The Resource iterator implementation for Resource Manager Project.
ResourceManagerProjectLienIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Resource Manager Lien.
ResourceManagerProjectOrgPolicyIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for CRM Project Org Policies.
SpannerDatabase
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Spanner Database.
SpannerDatabaseIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Cloud DNS ManagedZone.
SpannerInstance
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Spanner Instance.
SpannerInstanceIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Cloud DNS Policy.
StorageBucket
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Storage Bucket.
StorageBucketIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Storage Bucket.
StorageObject
(data, root=False, contains=None, metadata=None, **kwargs)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceSubclass
The Resource implementation for Storage Object.
StorageObjectIterator
(resource, client)[source]¶Bases: google.cloud.forseti.services.inventory.base.resources.ResourceIteratorSubclass
The Resource iterator implementation for Storage Object.
cached
(field_name)[source]¶Decorator to perform caching.
Parameters: | field_name (str) – The name of the attribute to cache. |
---|---|
Returns: | Function wrapper to perform caching. |
Return type: | wrapper |
compute_iter_class_factory
(api_method_name, resource_name)[source]¶Factory function to generate ResourceIterator subclasses for Compute.
Parameters: |
|
---|---|
Returns: | A new class object. |
Return type: | class |
from_root_id
(client, root_id, root=True)[source]¶Start the crawling from root if the root type is supported.
Parameters: |
|
---|---|
Returns: | the root resource instance. |
Return type: | |
Raises: |
|
resource_class_factory
(resource_type, key_field, hash_key=False)[source]¶Factory function to generate Resource subclasses.
Parameters: |
|
---|---|
Returns: | A new class object. |
Return type: | class |
resource_iter_class_factory
(api_method_name, resource_name, api_method_arg_key=None, additional_arg_keys=None, resource_validation_method_name=None, **kwargs)[source]¶Factory function to generate ResourceIterator subclasses.
Parameters: |
|
---|---|
Returns: | A new class object. |
Return type: | class |