OsConfigZonalServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.osconfig_v1.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Zonal OS Config API The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
OsConfigZonalServiceTransport | The transport used by the client instance. |
Methods
OsConfigZonalServiceAsyncClient
OsConfigZonalServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.osconfig_v1.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the os config zonal service client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
OsConfigZonalServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
OsConfigZonalServiceAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
OsConfigZonalServiceAsyncClient | The constructed client. |
get_inventory
get_inventory(request: Optional[Union[google.cloud.osconfig_v1.types.inventory.GetInventoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get inventory data for the specified VM instance. If the VM has
no associated inventory, the message NOT_FOUND
is returned.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.osconfig_v1.types.GetInventoryRequest, dict]
The request object. A request message for getting inventory data for the specified VM. |
name |
Required. API resource name for inventory resource. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.osconfig_v1.types.Inventory | This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](\ https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected). |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
get_vulnerability_report
get_vulnerability_report(request: Optional[Union[google.cloud.osconfig_v1.types.vulnerability.GetVulnerabilityReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.osconfig_v1.types.GetVulnerabilityReportRequest, dict]
The request object. A request message for getting the vulnerability report for the specified VM. |
name |
Required. API resource name for vulnerability resource. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.osconfig_v1.types.VulnerabilityReport | This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](\ https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports). |
instance_path
instance_path(project: str, zone: str, instance: str)
Returns a fully-qualified instance string.
inventory_path
inventory_path(project: str, location: str, instance: str)
Returns a fully-qualified inventory string.
list_inventories
list_inventories(request: Optional[Union[google.cloud.osconfig_v1.types.inventory.ListInventoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List inventory data for all VM instances in the specified zone.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.osconfig_v1.types.ListInventoriesRequest, dict]
The request object. A request message for listing inventory data for all VMs in the specified location. |
parent |
Required. The parent resource name. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.osconfig_v1.services.os_config_zonal_service.pagers.ListInventoriesAsyncPager | A response message for listing inventory data for all VMs in a specified location. Iterating over this object will yield results and resolve additional pages automatically. |
list_vulnerability_reports
list_vulnerability_reports(request: Optional[Union[google.cloud.osconfig_v1.types.vulnerability.ListVulnerabilityReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List vulnerability reports for all VM instances in the specified zone.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.osconfig_v1.types.ListVulnerabilityReportsRequest, dict]
The request object. A request message for listing vulnerability reports for all VM instances in the specified location. |
parent |
Required. The parent resource name. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.osconfig_v1.services.os_config_zonal_service.pagers.ListVulnerabilityReportsAsyncPager | A response message for listing vulnerability reports for all VM instances in the specified location. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_instance_path
parse_instance_path(path: str)
Parses a instance path into its component segments.
parse_inventory_path
parse_inventory_path(path: str)
Parses a inventory path into its component segments.
parse_vulnerability_report_path
parse_vulnerability_report_path(path: str)
Parses a vulnerability_report path into its component segments.
vulnerability_report_path
vulnerability_report_path(project: str, location: str, instance: str)
Returns a fully-qualified vulnerability_report string.