Summary of entries of Methods for osconfig.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient
OsConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport, typing.Callable[[...], google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the os config service async client.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.cancel_patch_job
cancel_patch_job(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Cancel a patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.cancel_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_folder_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_location_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.common_project_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.create_patch_deployment
create_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.CreatePatchDeploymentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
patch_deployment: typing.Optional[
google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
] = None,
patch_deployment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Create an OS Config patch deployment.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.delete_patch_deployment
delete_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Delete an OS Config patch deployment.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.execute_patch_job
execute_patch_job(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Patch VM instances by creating and running a patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.execute_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_patch_deployment
get_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Get an OS Config patch deployment.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_patch_job
get_patch_job(
request: typing.Optional[
typing.Union[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Get the patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport
]
Returns an appropriate transport class.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.get_transport_class
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.instance_path
instance_path(project: str, zone: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.instance_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.list_patch_deployments
list_patch_deployments(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager
)
Get a page of OS Config patch deployments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.list_patch_job_instance_details
list_patch_job_instance_details(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager
)
Get a list of instance details for a given patch job.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.list_patch_jobs
list_patch_jobs(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager
Get a list of patch jobs.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.list_patch_jobs
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_instance_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_patch_deployment_path
parse_patch_deployment_path(path: str) -> typing.Dict[str, str]
Parses a patch_deployment path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_patch_job_path
parse_patch_job_path(path: str) -> typing.Dict[str, str]
Parses a patch_job path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.parse_patch_job_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.patch_deployment_path
patch_deployment_path(project: str, patch_deployment: str) -> str
Returns a fully-qualified patch_deployment string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.patch_deployment_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.patch_job_path
patch_job_path(project: str, patch_job: str) -> str
Returns a fully-qualified patch_job string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.patch_job_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.pause_patch_deployment
pause_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.PausePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Change state of patch deployment to "PAUSED".
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.resume_patch_deployment
resume_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.ResumePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Change state of patch deployment back to "ACTIVE".
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceAsyncClient.update_patch_deployment
update_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.UpdatePatchDeploymentRequest,
dict,
]
] = None,
*,
patch_deployment: typing.Optional[
google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Update an OS Config patch deployment.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient
OsConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport, typing.Callable[[...], google.cloud.osconfig_v1.services.os_config_service.transports.base.OsConfigServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the os config service client.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.exit
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.cancel_patch_job
cancel_patch_job(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.CancelPatchJobRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Cancel a patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.cancel_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_folder_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_location_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_organization_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.common_project_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.create_patch_deployment
create_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.CreatePatchDeploymentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
patch_deployment: typing.Optional[
google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
] = None,
patch_deployment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Create an OS Config patch deployment.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.create_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.delete_patch_deployment
delete_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.DeletePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Delete an OS Config patch deployment.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.delete_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.execute_patch_job
execute_patch_job(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ExecutePatchJobRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Patch VM instances by creating and running a patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.execute_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_file
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_info
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.from_service_account_json
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.get_patch_deployment
get_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.GetPatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Get an OS Config patch deployment.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.get_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.get_patch_job
get_patch_job(
request: typing.Optional[
typing.Union[google.cloud.osconfig_v1.types.patch_jobs.GetPatchJobRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_jobs.PatchJob
Get the patch job.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.get_patch_job
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.instance_path
instance_path(project: str, zone: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.instance_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.list_patch_deployments
list_patch_deployments(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager
)
Get a page of OS Config patch deployments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.list_patch_deployments
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.list_patch_job_instance_details
list_patch_job_instance_details(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager
)
Get a list of instance details for a given patch job.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.list_patch_jobs
list_patch_jobs(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager
Get a list of patch jobs.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.list_patch_jobs
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_folder_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_location_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_common_project_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_instance_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_patch_deployment_path
parse_patch_deployment_path(path: str) -> typing.Dict[str, str]
Parses a patch_deployment path into its component segments.
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_patch_job_path
parse_patch_job_path(path: str) -> typing.Dict[str, str]
Parses a patch_job path into its component segments.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.parse_patch_job_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.patch_deployment_path
patch_deployment_path(project: str, patch_deployment: str) -> str
Returns a fully-qualified patch_deployment string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.patch_deployment_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.patch_job_path
patch_job_path(project: str, patch_job: str) -> str
Returns a fully-qualified patch_job string.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.patch_job_path
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.pause_patch_deployment
pause_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.PausePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Change state of patch deployment to "PAUSED".
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.pause_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.resume_patch_deployment
resume_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.ResumePatchDeploymentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Change state of patch deployment back to "ACTIVE".
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.resume_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.update_patch_deployment
update_patch_deployment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.patch_deployments.UpdatePatchDeploymentRequest,
dict,
]
] = None,
*,
patch_deployment: typing.Optional[
google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.osconfig_v1.types.patch_deployments.PatchDeployment
Update an OS Config patch deployment.
See more: google.cloud.osconfig_v1.services.os_config_service.OsConfigServiceClient.update_patch_deployment
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager
ListPatchDeploymentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse
],
],
request: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest,
response: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsAsyncPager
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager
ListPatchDeploymentsPager(
method: typing.Callable[
[...],
google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse,
],
request: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsRequest,
response: google.cloud.osconfig_v1.types.patch_deployments.ListPatchDeploymentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchDeploymentsPager
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager
ListPatchJobInstanceDetailsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse
],
],
request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest,
response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsAsyncPager
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager
ListPatchJobInstanceDetailsPager(
method: typing.Callable[
[...],
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse,
],
request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsRequest,
response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobInstanceDetailsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobInstanceDetailsPager
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager
ListPatchJobsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse
],
],
request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest,
response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsAsyncPager
google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager
ListPatchJobsPager(
method: typing.Callable[
[...], google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse
],
request: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsRequest,
response: google.cloud.osconfig_v1.types.patch_jobs.ListPatchJobsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.osconfig_v1.services.os_config_service.pagers.ListPatchJobsPager
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient
OsConfigZonalServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.osconfig_v1.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport, typing.Callable[[...], google.cloud.osconfig_v1.services.os_config_zonal_service.transports.base.OsConfigZonalServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the os config zonal service async client.
See more: google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.create_os_policy_assignment
create_os_policy_assignment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.os_policy_assignments.CreateOSPolicyAssignmentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
os_policy_assignment: typing.Optional[
google.cloud.osconfig_v1.types.os_policy_assignments.OSPolicyAssignment
] = None,
os_policy_assignment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create an OS policy assignment.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.delete_os_policy_assignment
delete_os_policy_assignment(
request: typing.Optional[
typing.Union[
google.cloud.osconfig_v1.types.os_policy_assignments.DeleteOSPolicyAssignmentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Delete the OS policy assignment.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.osconfig_v1.services.os_config_zonal_service.OsConfigZonalServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: