ConfigClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.config_v1.services.config.transports.base.ConfigTransport, typing.Callable[[...], google.cloud.config_v1.services.config.transports.base.ConfigTransport]]] = 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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
ConfigTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
ConfigClient
ConfigClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.config_v1.services.config.transports.base.ConfigTransport, typing.Callable[[...], google.cloud.config_v1.services.config.transports.base.ConfigTransport]]] = 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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the config 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 |
Optional[Union[str,ConfigTransport,Callable[..., ConfigTransport]]]
The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ConfigTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = 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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_deployment
create_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.CreateDeploymentRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
deployment: typing.Optional[google.cloud.config_v1.types.config.Deployment] = None,
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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_create_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
deployment = config_v1.Deployment()
deployment.terraform_blueprint.gcs_source = "gcs_source_value"
request = config_v1.CreateDeploymentRequest(
parent="parent_value",
deployment_id="deployment_id_value",
deployment=deployment,
)
# Make the request
operation = client.create_deployment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.CreateDeploymentRequest, dict]
The request object. |
parent |
str
Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'. This corresponds to the |
deployment |
google.cloud.config_v1.types.Deployment
Required. Deployment resource to be created. This corresponds to the |
deployment_id |
str
Required. The Deployment ID. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Deployment A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
create_preview
create_preview(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.CreatePreviewRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
preview: typing.Optional[google.cloud.config_v1.types.config.Preview] = 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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Preview.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_create_preview():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
preview = config_v1.Preview()
preview.terraform_blueprint.gcs_source = "gcs_source_value"
request = config_v1.CreatePreviewRequest(
parent="parent_value",
preview=preview,
)
# Make the request
operation = client.create_preview(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.CreatePreviewRequest, dict]
The request object. A request to create a preview. |
parent |
str
Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'. This corresponds to the |
preview |
google.cloud.config_v1.types.Preview
Required. Preview resource to be created. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Preview A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration. |
delete_deployment
delete_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.DeleteDeploymentRequest, 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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_delete_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.DeleteDeploymentRequest(
name="name_value",
)
# Make the request
operation = client.delete_deployment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.DeleteDeploymentRequest, dict]
The request object. |
name |
str
Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Deployment A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = 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, str]] = ()
) -> None
Deletes a long-running operation.
This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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. |
delete_preview
delete_preview(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.DeletePreviewRequest, 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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Preview.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_delete_preview():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.DeletePreviewRequest(
name="name_value",
)
# Make the request
operation = client.delete_preview(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.DeletePreviewRequest, dict]
The request object. A request to delete a preview. |
name |
str
Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Preview A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration. |
delete_statefile
delete_statefile(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.DeleteStatefileRequest, 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, str]] = ()
) -> None
Deletes Terraform state file in a given deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_delete_statefile():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.DeleteStatefileRequest(
name="name_value",
lock_id=725,
)
# Make the request
client.delete_statefile(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.DeleteStatefileRequest, dict]
The request object. A request to delete a state file passed to a 'DeleteStatefile' call. |
name |
str
Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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. |
deployment_path
deployment_path(project: str, location: str, deployment: str) -> str
Returns a fully-qualified deployment string.
export_deployment_statefile
export_deployment_statefile(
request: typing.Optional[
typing.Union[
google.cloud.config_v1.types.config.ExportDeploymentStatefileRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Statefile
Exports Terraform state file from a given deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_export_deployment_statefile():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ExportDeploymentStatefileRequest(
parent="parent_value",
)
# Make the request
response = client.export_deployment_statefile(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ExportDeploymentStatefileRequest, dict]
The request object. A request to export a state file passed to a 'ExportDeploymentStatefile' call. |
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.config_v1.types.Statefile |
Contains info about a Terraform state file |
export_lock_info
export_lock_info(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ExportLockInfoRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.LockInfo
Exports the lock info on a locked deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_export_lock_info():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ExportLockInfoRequest(
name="name_value",
)
# Make the request
response = client.export_lock_info(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ExportLockInfoRequest, dict]
The request object. A request to get a state file lock info passed to a 'ExportLockInfo' call. |
name |
str
Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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.config_v1.types.LockInfo |
Details about the lock which locked the deployment. |
export_preview_result
export_preview_result(
request: typing.Optional[
typing.Union[
google.cloud.config_v1.types.config.ExportPreviewResultRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.ExportPreviewResultResponse
Export xref_Preview results.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_export_preview_result():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ExportPreviewResultRequest(
parent="parent_value",
)
# Make the request
response = client.export_preview_result(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ExportPreviewResultRequest, dict]
The request object. A request to export preview results. |
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.config_v1.types.ExportPreviewResultResponse |
A response to ExportPreviewResult call. Contains preview results. |
export_revision_statefile
export_revision_statefile(
request: typing.Optional[
typing.Union[
google.cloud.config_v1.types.config.ExportRevisionStatefileRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Statefile
Exports Terraform state file from a given revision.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_export_revision_statefile():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ExportRevisionStatefileRequest(
parent="parent_value",
)
# Make the request
response = client.export_revision_statefile(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ExportRevisionStatefileRequest, dict]
The request object. A request to export a state file passed to a 'ExportRevisionStatefile' call. |
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.config_v1.types.Statefile |
Contains info about a Terraform state file |
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 |
ConfigClient |
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 |
ConfigClient |
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 |
ConfigClient |
The constructed client. |
get_deployment
get_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.GetDeploymentRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Deployment
Gets details about a xref_Deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_get_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.GetDeploymentRequest(
name="name_value",
)
# Make the request
response = client.get_deployment(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.GetDeploymentRequest, dict]
The request object. |
name |
str
Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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.config_v1.types.Deployment |
A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = 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, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
Returns an empty policy if the function exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __. |
get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Location object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = 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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
An Operation object. |
get_preview
get_preview(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.GetPreviewRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Preview
Gets details about a xref_Preview.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_get_preview():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.GetPreviewRequest(
name="name_value",
)
# Make the request
response = client.get_preview(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.GetPreviewRequest, dict]
The request object. A request to get details about a preview. |
name |
str
Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'. This corresponds to the |
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.config_v1.types.Preview |
A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration. |
get_resource
get_resource(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.GetResourceRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Resource
Gets details about a xref_Resource deployed by Infra Manager.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_get_resource():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.GetResourceRequest(
name="name_value",
)
# Make the request
response = client.get_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.GetResourceRequest, dict]
The request object. A request to get a Resource from a 'GetResource' call. |
name |
str
Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'. This corresponds to the |
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.config_v1.types.Resource |
Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions. |
get_revision
get_revision(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.GetRevisionRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.Revision
Gets details about a xref_Revision.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_get_revision():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.GetRevisionRequest(
name="name_value",
)
# Make the request
response = client.get_revision(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.GetRevisionRequest, dict]
The request object. A request to get a Revision from a 'GetRevision' call. |
name |
str
Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'. This corresponds to the |
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.config_v1.types.Revision |
A child resource of a Deployment generated by a 'CreateDeployment' or 'UpdateDeployment' call. Each Revision contains metadata pertaining to a snapshot of a particular Deployment. |
get_terraform_version
get_terraform_version(
request: typing.Optional[
typing.Union[
google.cloud.config_v1.types.config.GetTerraformVersionRequest, 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, str]] = ()
) -> google.cloud.config_v1.types.config.TerraformVersion
Gets details about a xref_TerraformVersion.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_get_terraform_version():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.GetTerraformVersionRequest(
name="name_value",
)
# Make the request
response = client.get_terraform_version(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.GetTerraformVersionRequest, dict]
The request object. The request message for the GetTerraformVersion method. |
name |
str
Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}' This corresponds to the |
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.config_v1.types.TerraformVersion |
A TerraformVersion represents the support state the corresponding Terraform version. |
import_statefile
import_statefile(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ImportStatefileRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
lock_id: typing.Optional[int] = 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, str]] = ()
) -> google.cloud.config_v1.types.config.Statefile
Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_import_statefile():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ImportStatefileRequest(
parent="parent_value",
lock_id=725,
)
# Make the request
response = client.import_statefile(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ImportStatefileRequest, dict]
The request object. A request to import a state file passed to a 'ImportStatefile' call. |
parent |
str
Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
lock_id |
int
Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment. This corresponds to the |
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.config_v1.types.Statefile |
Contains info about a Terraform state file |
list_deployments
list_deployments(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ListDeploymentsRequest, 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, str]] = ()
) -> google.cloud.config_v1.services.config.pagers.ListDeploymentsPager
Lists xref_Deployments in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_list_deployments():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ListDeploymentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_deployments(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ListDeploymentsRequest, dict]
The request object. |
parent |
str
Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. This corresponds to the |
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.config_v1.services.config.pagers.ListDeploymentsPager |
Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Response message for ListLocations method. |
list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = 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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Response message for ListOperations method. |
list_previews
list_previews(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ListPreviewsRequest, 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, str]] = ()
) -> google.cloud.config_v1.services.config.pagers.ListPreviewsPager
Lists xref_Previews in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_list_previews():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ListPreviewsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_previews(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ListPreviewsRequest, dict]
The request object. A request to list all previews for a given project and location. |
parent |
str
Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. This corresponds to the |
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.config_v1.services.config.pagers.ListPreviewsPager |
A response to a ListPreviews call. Contains a list of Previews. Iterating over this object will yield results and resolve additional pages automatically. |
list_resources
list_resources(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ListResourcesRequest, 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, str]] = ()
) -> google.cloud.config_v1.services.config.pagers.ListResourcesPager
Lists xref_Resources in a given revision.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_list_resources():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ListResourcesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_resources(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ListResourcesRequest, dict]
The request object. A request to list Resources passed to a 'ListResources' call. |
parent |
str
Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'. This corresponds to the |
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.config_v1.services.config.pagers.ListResourcesPager |
A response to a 'ListResources' call. Contains a list of Resources. Iterating over this object will yield results and resolve additional pages automatically. |
list_revisions
list_revisions(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.ListRevisionsRequest, 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, str]] = ()
) -> google.cloud.config_v1.services.config.pagers.ListRevisionsPager
Lists xref_Revisions of a deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_list_revisions():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ListRevisionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_revisions(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ListRevisionsRequest, dict]
The request object. A request to list Revisions passed to a 'ListRevisions' call. |
parent |
str
Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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.config_v1.services.config.pagers.ListRevisionsPager |
A response to a 'ListRevisions' call. Contains a list of Revisions. Iterating over this object will yield results and resolve additional pages automatically. |
list_terraform_versions
list_terraform_versions(
request: typing.Optional[
typing.Union[
google.cloud.config_v1.types.config.ListTerraformVersionsRequest, 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, str]] = ()
) -> google.cloud.config_v1.services.config.pagers.ListTerraformVersionsPager
Lists xref_TerraformVersions in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_list_terraform_versions():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.ListTerraformVersionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_terraform_versions(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.ListTerraformVersionsRequest, dict]
The request object. The request message for the ListTerraformVersions method. |
parent |
str
Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. This corresponds to the |
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.config_v1.services.config.pagers.ListTerraformVersionsPager |
The response message for the ListTerraformVersions method. Iterating over this object will yield results and resolve additional pages automatically. |
lock_deployment
lock_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.LockDeploymentRequest, 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, str]] = ()
) -> google.api_core.operation.Operation
Locks a deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_lock_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.LockDeploymentRequest(
name="name_value",
)
# Make the request
operation = client.lock_deployment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.LockDeploymentRequest, dict]
The request object. A request to lock a deployment passed to a 'LockDeployment' call. |
name |
str
Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Deployment A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
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.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_deployment_path
parse_deployment_path(path: str) -> typing.Dict[str, str]
Parses a deployment path into its component segments.
parse_preview_path
parse_preview_path(path: str) -> typing.Dict[str, str]
Parses a preview path into its component segments.
parse_resource_path
parse_resource_path(path: str) -> typing.Dict[str, str]
Parses a resource path into its component segments.
parse_revision_path
parse_revision_path(path: str) -> typing.Dict[str, str]
Parses a revision path into its component segments.
parse_service_account_path
parse_service_account_path(path: str) -> typing.Dict[str, str]
Parses a service_account path into its component segments.
parse_terraform_version_path
parse_terraform_version_path(path: str) -> typing.Dict[str, str]
Parses a terraform_version path into its component segments.
parse_worker_pool_path
parse_worker_pool_path(path: str) -> typing.Dict[str, str]
Parses a worker_pool path into its component segments.
preview_path
preview_path(project: str, location: str, preview: str) -> str
Returns a fully-qualified preview string.
resource_path
resource_path(
project: str, location: str, deployment: str, revision: str, resource: str
) -> str
Returns a fully-qualified resource string.
revision_path
revision_path(project: str, location: str, deployment: str, revision: str) -> str
Returns a fully-qualified revision string.
service_account_path
service_account_path(project: str, service_account: str) -> str
Returns a fully-qualified service_account string.
set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = 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, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __. |
terraform_version_path
terraform_version_path(project: str, location: str, terraform_version: str) -> str
Returns a fully-qualified terraform_version string.
test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = 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, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
|
Response message for TestIamPermissions method. |
unlock_deployment
unlock_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.UnlockDeploymentRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
lock_id: typing.Optional[int] = 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, str]] = ()
) -> google.api_core.operation.Operation
Unlocks a locked deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_unlock_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
request = config_v1.UnlockDeploymentRequest(
name="name_value",
lock_id=725,
)
# Make the request
operation = client.unlock_deployment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.UnlockDeploymentRequest, dict]
The request object. A request to unlock a state file passed to a 'UnlockDeployment' call. |
name |
str
Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. This corresponds to the |
lock_id |
int
Required. Lock ID of the lock file to be unlocked. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Deployment A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
update_deployment
update_deployment(
request: typing.Optional[
typing.Union[google.cloud.config_v1.types.config.UpdateDeploymentRequest, dict]
] = None,
*,
deployment: typing.Optional[google.cloud.config_v1.types.config.Deployment] = 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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_Deployment.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1
def sample_update_deployment():
# Create a client
client = config_v1.ConfigClient()
# Initialize request argument(s)
deployment = config_v1.Deployment()
deployment.terraform_blueprint.gcs_source = "gcs_source_value"
request = config_v1.UpdateDeploymentRequest(
deployment=deployment,
)
# Make the request
operation = client.update_deployment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.config_v1.types.UpdateDeploymentRequest, dict]
The request object. |
deployment |
google.cloud.config_v1.types.Deployment
Required. Deployment to update. The deployment's |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
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.api_core.operation.Operation |
An object representing a long-running operation. The result type for the operation will be Deployment A Deployment is a group of resources and configs managed and provisioned by Infra Manager. |
worker_pool_path
worker_pool_path(project: str, location: str, worker_pool: str) -> str
Returns a fully-qualified worker_pool string.