DesignCenterAsyncClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.designcenter_v1.services.design_center.transports.base.DesignCenterTransport,
typing.Callable[
[...],
google.cloud.designcenter_v1.services.design_center.transports.base.DesignCenterTransport,
],
]
] = "grpc_asyncio",
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)Service describing handlers for 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 |
DesignCenterTransport |
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
DesignCenterAsyncClient
DesignCenterAsyncClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.designcenter_v1.services.design_center.transports.base.DesignCenterTransport,
typing.Callable[
[...],
google.cloud.designcenter_v1.services.design_center.transports.base.DesignCenterTransport,
],
]
] = "grpc_asyncio",
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)Instantiates the design center async 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,DesignCenterTransport,Callable[..., DesignCenterTransport]]]
The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the DesignCenterTransport 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. |
application_path
application_path(project: str, location: str, space: str, application: str) -> strReturns a fully-qualified application string.
application_template_path
application_template_path(
project: str, location: str, space: str, application_template: str
) -> strReturns a fully-qualified application_template string.
application_template_revision_path
application_template_revision_path(
project: str, location: str, space: str, application_template: str, revision: str
) -> strReturns a fully-qualified application_template_revision string.
application_template_system_revision_path
application_template_system_revision_path(
project: str,
location: str,
space: str,
application_template: str,
system_revision: str,
) -> strReturns a fully-qualified application_template_system_revision string.
cancel_operation
cancel_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, 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]]] = ()
) -> NoneStarts 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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
catalog_path
catalog_path(project: str, location: str, space: str, catalog: str) -> strReturns a fully-qualified catalog string.
catalog_template_path
catalog_template_path(
project: str, location: str, space: str, catalog: str, catalog_template: str
) -> strReturns a fully-qualified catalog_template string.
catalog_template_revision_path
catalog_template_revision_path(
project: str,
location: str,
space: str,
catalog: str,
catalog_template: str,
revision: str,
) -> strReturns a fully-qualified catalog_template_revision string.
cloud_control_path
cloud_control_path(organization: str, location: str, cloud_control: str) -> strReturns a fully-qualified cloud_control string.
commit_application_template
commit_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.CommitApplicationTemplateRequest,
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.designcenter_v1.types.authoring.ApplicationTemplateRevisionCommits an application template to create a new 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 designcenter_v1
async def sample_commit_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.CommitApplicationTemplateRequest(
name="name_value",
)
# Make the request
response = await client.commit_application_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CommitApplicationTemplateRequest, dict]]
The request object. Request message for CommitApplicationTemplate method. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplateRevision |
Application template revision resource. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
component_path
component_path(
project: str, location: str, space: str, application_template: str, component: str
) -> strReturns a fully-qualified component string.
connection_path
connection_path(
project: str,
location: str,
space: str,
application_template: str,
component: str,
connection: str,
) -> strReturns a fully-qualified connection string.
create_application
create_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.CreateApplicationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
application: typing.Optional[
google.cloud.designcenter_v1.types.deployment_resources.Application
] = None,
application_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.designcenter_v1.types.deployment_resources.ApplicationCreates an application.
# 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 designcenter_v1
async def sample_create_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
application = designcenter_v1.Application()
application.source.application_template_revision = "application_template_revision_value"
application.scope.type_ = "GLOBAL"
request = designcenter_v1.CreateApplicationRequest(
parent="parent_value",
application_id="application_id_value",
application=application,
)
# Make the request
response = await client.create_application(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateApplicationRequest, dict]]
The request object. Message for creating an application. |
parent |
Required. The parent resource in which to create the application. Format: |
application |
Application
Required. The application to create. This corresponds to the |
application_id |
Required. The ID of the application to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Application |
Represents the application resource. |
create_application_template
create_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.CreateApplicationTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
application_template: typing.Optional[
google.cloud.designcenter_v1.types.authoring.ApplicationTemplate
] = None,
application_template_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.designcenter_v1.types.authoring.ApplicationTemplateCreates an application template.
# 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 designcenter_v1
async def sample_create_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.CreateApplicationTemplateRequest(
parent="parent_value",
application_template_id="application_template_id_value",
)
# Make the request
response = await client.create_application_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateApplicationTemplateRequest, dict]]
The request object. Message for creating an application template. |
parent |
Required. The parent resource in which to create the application template. This corresponds to the |
application_template |
ApplicationTemplate
Required. The application template to create. This corresponds to the |
application_template_id |
Required. The ID of the application template to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplate |
Application template resource. |
create_catalog
create_catalog(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.CreateCatalogRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
catalog: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.Catalog
] = None,
catalog_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.designcenter_v1.types.catalog_management.CatalogCreates a catalog.
# 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 designcenter_v1
async def sample_create_catalog():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.CreateCatalogRequest(
parent="parent_value",
catalog_id="catalog_id_value",
)
# Make the request
response = await client.create_catalog(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateCatalogRequest, dict]]
The request object. Message for creating a catalog. |
parent |
Required. The parent space in which a catalog is created in the following format: |
catalog |
Catalog
Required. The catalog to create. This corresponds to the |
catalog_id |
Required. The ID of the catalog to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Catalog |
A catalog is a collection of templates. |
create_catalog_template
create_catalog_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.CreateCatalogTemplateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
catalog_template: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.CatalogTemplate
] = None,
catalog_template_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.designcenter_v1.types.catalog_management.CatalogTemplateAdds a template to a catalog.
# 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 designcenter_v1
async def sample_create_catalog_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
catalog_template = designcenter_v1.CatalogTemplate()
catalog_template.template_category = "INSTANCE_TEMPLATE"
request = designcenter_v1.CreateCatalogTemplateRequest(
parent="parent_value",
catalog_template_id="catalog_template_id_value",
catalog_template=catalog_template,
)
# Make the request
response = await client.create_catalog_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateCatalogTemplateRequest, dict]]
The request object. Message for creating a catalog template. |
parent |
Required. The parent resource in which the catalog template is created. This corresponds to the |
catalog_template |
CatalogTemplate
Required. The catalog template to create. This corresponds to the |
catalog_template_id |
Required. The ID of the catalog template to create. The ID is appended to the catalog template's name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.CatalogTemplate |
A template inside a catalog. |
create_catalog_template_revision
create_catalog_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.CreateCatalogTemplateRevisionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
catalog_template_revision: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.CatalogTemplateRevision
] = None,
catalog_template_revision_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.AsyncOperationCreates a template 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 designcenter_v1
async def sample_create_catalog_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
catalog_template_revision = designcenter_v1.CatalogTemplateRevision()
catalog_template_revision.git_source.repo = "repo_value"
catalog_template_revision.git_source.ref_tag = "ref_tag_value"
request = designcenter_v1.CreateCatalogTemplateRevisionRequest(
parent="parent_value",
catalog_template_revision_id="catalog_template_revision_id_value",
catalog_template_revision=catalog_template_revision,
)
# Make the request
operation = await client.create_catalog_template_revision(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateCatalogTemplateRevisionRequest, dict]]
The request object. Message for creating a template revisions request. |
parent |
Required. The parent in which the catalog template revisions request is created in following format: |
catalog_template_revision |
CatalogTemplateRevision
Required. The template revision to create. This corresponds to the |
catalog_template_revision_id |
Required. The ID of the template revision to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be CatalogTemplateRevision Template revisions inside a catalog. |
create_component
create_component(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.CreateComponentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
component: typing.Optional[
google.cloud.designcenter_v1.types.authoring.Component
] = None,
component_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.designcenter_v1.types.authoring.ComponentCreates a component.
# 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 designcenter_v1
async def sample_create_component():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
component = designcenter_v1.Component()
component.shared_template_revision_uri = "shared_template_revision_uri_value"
request = designcenter_v1.CreateComponentRequest(
parent="parent_value",
component_id="component_id_value",
component=component,
)
# Make the request
response = await client.create_component(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateComponentRequest, dict]]
The request object. Message for creating a component. |
parent |
Required. The parent resource in which to create the component. This corresponds to the |
component |
Component
Required. The component to create. This corresponds to the |
component_id |
Required. The ID of the component to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Component |
Component resource. |
create_connection
create_connection(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.CreateConnectionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
connection: typing.Optional[
google.cloud.designcenter_v1.types.authoring.Connection
] = None,
connection_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.designcenter_v1.types.authoring.ConnectionCreates a connection.
# 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 designcenter_v1
async def sample_create_connection():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
connection = designcenter_v1.Connection()
connection.destination_component_uri = "destination_component_uri_value"
request = designcenter_v1.CreateConnectionRequest(
parent="parent_value",
connection_id="connection_id_value",
connection=connection,
)
# Make the request
response = await client.create_connection(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateConnectionRequest, dict]]
The request object. Message for creating a connection. |
parent |
Required. The parent resource in which to create a connection. This corresponds to the |
connection |
Connection
Required. The connection to create. This corresponds to the |
connection_id |
Required. The ID of the connection to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Connection |
Connection resource. |
create_policy
create_policy(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.CreatePolicyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
policy: typing.Optional[
google.cloud.designcenter_v1.types.best_practices.Policy
] = None,
policy_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.designcenter_v1.types.best_practices.PolicyCreates a policy for an application template.
# 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 designcenter_v1
async def sample_create_policy():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
policy = designcenter_v1.Policy()
policy.policy_uri = "policy_uri_value"
policy.policy_type = "COMPLIANCE_FRAMEWORK"
request = designcenter_v1.CreatePolicyRequest(
parent="parent_value",
policy_id="policy_id_value",
policy=policy,
)
# Make the request
response = await client.create_policy(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreatePolicyRequest, dict]]
The request object. Message for creating a policy. |
parent |
Required. The parent resource in which to create the policy in the following format: |
policy |
Policy
Required. The policy to create. This corresponds to the |
policy_id |
Required. The ID of the policy to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Policy |
A Policy is a resource within an Application Template that refers to a Policy that you author outside of Application Design Center and attach to an application template. |
create_share
create_share(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.CreateShareRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
share: typing.Optional[google.cloud.designcenter_v1.types.sharing.Share] = None,
share_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.AsyncOperationShares a catalog from one space to another space.
# 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 designcenter_v1
async def sample_create_share():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
share = designcenter_v1.Share()
share.destination_space = "destination_space_value"
request = designcenter_v1.CreateShareRequest(
parent="parent_value",
share_id="share_id_value",
share=share,
)
# Make the request
operation = await client.create_share(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateShareRequest, dict]]
The request object. Message for creating a share of a catalog. |
parent |
Required. The parent resource in which shares are created. This corresponds to the |
share |
Share
Required. The share to create. This corresponds to the |
share_id |
Required. The ID of the share to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Share A catalog share between spaces. |
create_space
create_space(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.CreateSpaceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
space: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.Space
] = None,
space_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.designcenter_v1.types.catalog_management.SpaceCreates a space.
# 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 designcenter_v1
async def sample_create_space():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.CreateSpaceRequest(
parent="parent_value",
space_id="space_id_value",
)
# Make the request
response = await client.create_space(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.CreateSpaceRequest, dict]]
The request object. Message for creating a space. |
parent |
Required. The parent in which to create a space. This corresponds to the |
space |
Space
Required. The space to create. This corresponds to the |
space_id |
Required. The ID of the space to create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Space |
Space is a top level resource for managing teams building applications through Application Design Center. |
delete_application
delete_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.DeleteApplicationRequest,
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.AsyncOperationDeletes an application.
# 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 designcenter_v1
async def sample_delete_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteApplicationRequest(
name="name_value",
)
# Make the request
operation = await client.delete_application(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteApplicationRequest, dict]]
The request object. Message for deleting an application. |
name |
Required. The application name. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_application_template
delete_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.DeleteApplicationTemplateRequest,
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]]] = ()
) -> NoneDeletes an application template.
# 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 designcenter_v1
async def sample_delete_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteApplicationTemplateRequest(
name="name_value",
)
# Make the request
await client.delete_application_template(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteApplicationTemplateRequest, dict]]
The request object. Message for deleting an application template. |
name |
Required. The application template name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_application_template_revision
delete_application_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.DeleteApplicationTemplateRevisionRequest,
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]]] = ()
) -> NoneDeletes an application template 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 designcenter_v1
async def sample_delete_application_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteApplicationTemplateRevisionRequest(
name="name_value",
)
# Make the request
await client.delete_application_template_revision(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteApplicationTemplateRevisionRequest, dict]]
The request object. Message for deleting an application template revision. |
name |
Required. The application template revision name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_catalog
delete_catalog(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.DeleteCatalogRequest,
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.AsyncOperationDeletes a catalog.
# 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 designcenter_v1
async def sample_delete_catalog():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteCatalogRequest(
name="name_value",
)
# Make the request
operation = await client.delete_catalog(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteCatalogRequest, dict]]
The request object. Message for deleting a catalog. |
name |
Required. The catalog name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_catalog_template
delete_catalog_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.DeleteCatalogTemplateRequest,
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.AsyncOperationDeletes a catalog template.
# 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 designcenter_v1
async def sample_delete_catalog_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteCatalogTemplateRequest(
name="name_value",
)
# Make the request
operation = await client.delete_catalog_template(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteCatalogTemplateRequest, dict]]
The request object. Message for deleting a catalog template. |
name |
Required. The catalog template name. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_catalog_template_revision
delete_catalog_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.DeleteCatalogTemplateRevisionRequest,
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.AsyncOperationDeletes a template 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 designcenter_v1
async def sample_delete_catalog_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteCatalogTemplateRevisionRequest(
name="name_value",
)
# Make the request
operation = await client.delete_catalog_template_revision(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteCatalogTemplateRevisionRequest, dict]]
The request object. Message for deleting a template revision. |
name |
Required. The template revision name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_component
delete_component(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.DeleteComponentRequest,
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]]] = ()
) -> NoneDeletes a component.
# 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 designcenter_v1
async def sample_delete_component():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteComponentRequest(
name="name_value",
)
# Make the request
await client.delete_component(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteComponentRequest, dict]]
The request object. Message for deleting a component. |
name |
Required. The component name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_connection
delete_connection(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.DeleteConnectionRequest,
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]]] = ()
) -> NoneDeletes a connection.
# 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 designcenter_v1
async def sample_delete_connection():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteConnectionRequest(
name="name_value",
)
# Make the request
await client.delete_connection(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteConnectionRequest, dict]]
The request object. Message for deleting a connection. |
name |
Required. The connection name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_operation
delete_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, 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]]] = ()
) -> NoneDeletes 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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_policy
delete_policy(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.DeletePolicyRequest,
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]]] = ()
) -> NoneDeletes a policy.
# 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 designcenter_v1
async def sample_delete_policy():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeletePolicyRequest(
name="name_value",
)
# Make the request
await client.delete_policy(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeletePolicyRequest, dict]]
The request object. Message for deleting a policy. |
name |
Required. The policy name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_share
delete_share(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.DeleteShareRequest, 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.AsyncOperationDeletes a catalog share.
# 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 designcenter_v1
async def sample_delete_share():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteShareRequest(
name="name_value",
)
# Make the request
operation = await client.delete_share(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteShareRequest, dict]]
The request object. Message for deleting a share of a catalog. |
name |
Required. The share name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_space
delete_space(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.DeleteSpaceRequest,
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]]] = ()
) -> NoneDeletes a space.
# 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 designcenter_v1
async def sample_delete_space():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeleteSpaceRequest(
name="name_value",
)
# Make the request
await client.delete_space(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeleteSpaceRequest, dict]]
The request object. Message for deleting a space. |
name |
Required. The space name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
deploy_application
deploy_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.DeployApplicationRequest,
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.AsyncOperationDeploys an application.
# 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 designcenter_v1
async def sample_deploy_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.DeployApplicationRequest(
name="name_value",
)
# Make the request
operation = await client.deploy_application(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.DeployApplicationRequest, dict]]
The request object. Message for deploying an application. |
name |
Required. The application name. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be DeployApplicationResponse Response for DeployApplication. |
deployment_group_path
deployment_group_path(project: str, location: str, deployment_group: str) -> strReturns a fully-qualified deployment_group string.
deployment_path
deployment_path(project: str, location: str, deployment: str) -> strReturns a fully-qualified deployment string.
export_application_ia_c
export_application_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.ExportApplicationIaCRequest,
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.AsyncOperationExports Terraform files for an application asynchronously.
# 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 designcenter_v1
async def sample_export_application_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ExportApplicationIaCRequest(
name="name_value",
)
# Make the request
operation = await client.export_application_ia_c(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ExportApplicationIaCRequest, dict]]
The request object. Request message for ExportApplicationIaC method. |
name |
Required. The name of the application. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be ExportApplicationIaCResponse Response message for ExportApplicationIaC method. |
export_application_template_ia_c
export_application_template_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ExportApplicationTemplateIaCRequest,
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.AsyncOperationExports Terraform files for an application template. The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.
# 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 designcenter_v1
async def sample_export_application_template_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ExportApplicationTemplateIaCRequest(
name="name_value",
)
# Make the request
operation = await client.export_application_template_ia_c(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ExportApplicationTemplateIaCRequest, dict]]
The request object. Request message for ExportApplicationTemplateIaC method. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be ExportApplicationTemplateIaCResponse Response message for ExportApplicationTemplateIaC method. |
export_application_template_revision_ia_c
export_application_template_revision_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ExportApplicationTemplateRevisionIaCRequest,
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.AsyncOperationExports Terraform files for an application template revision. The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.
# 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 designcenter_v1
async def sample_export_application_template_revision_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ExportApplicationTemplateRevisionIaCRequest(
name="name_value",
)
# Make the request
operation = await client.export_application_template_revision_ia_c(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ExportApplicationTemplateRevisionIaCRequest, dict]]
The request object. Request message for ExportApplicationTemplateRevisionIaC method. |
name |
Required. The name of the application template revision. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be ExportApplicationTemplateRevisionIaCResponse Response message for ExportApplicationTemplateRevisionIaC method. |
fetch_application_assessment_report
fetch_application_assessment_report(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.FetchApplicationAssessmentReportRequest,
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.designcenter_v1.types.best_practices_messages.FetchApplicationAssessmentReportResponse
)Fetches the assessment report of a deployed application if present.
# 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 designcenter_v1
async def sample_fetch_application_assessment_report():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.FetchApplicationAssessmentReportRequest(
name="name_value",
)
# Make the request
response = await client.fetch_application_assessment_report(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.FetchApplicationAssessmentReportRequest, dict]]
The request object. Message for fetching an application assessment report. |
name |
Required. The application name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.FetchApplicationAssessmentReportResponse |
Message for response of fetching an application assessment report. |
fetch_frameworks
fetch_frameworks(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.FetchFrameworksRequest,
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.designcenter_v1.services.design_center.pagers.FetchFrameworksAsyncPager
)Fetches all frameworks for assessment report.
# 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 designcenter_v1
async def sample_fetch_frameworks():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.FetchFrameworksRequest(
parent="parent_value",
)
# Make the request
page_result = client.fetch_frameworks(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.FetchFrameworksRequest, dict]]
The request object. Request for FetchFrameworks rpc |
parent |
Required. The parent resource name. Format: projects/{project}/locations/{location} This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.FetchFrameworksAsyncPager |
Response for FetchFrameworks rpc Iterating over this object will yield results and resolve additional pages automatically. |
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 |
DesignCenterAsyncClient |
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 |
DesignCenterAsyncClient |
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 |
DesignCenterAsyncClient |
The constructed client. |
generate_application_assessment_report
generate_application_assessment_report(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.GenerateApplicationAssessmentReportRequest,
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.AsyncOperationGenerate Assessment Reports of an application.
# 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 designcenter_v1
async def sample_generate_application_assessment_report():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateApplicationAssessmentReportRequest(
name="name_value",
)
# Make the request
operation = await client.generate_application_assessment_report(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateApplicationAssessmentReportRequest, dict]]
The request object. Message for generating an application assessment report. |
name |
Required. The application name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be GenerateApplicationAssessmentReportResponse Response for GenerateApplicationAssessmentReport. |
generate_application_ia_c
generate_application_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.GenerateApplicationIaCRequest,
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.designcenter_v1.types.deployment_messages.GenerateApplicationIaCResponse
)Generates Terraform files for an application.
# 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 designcenter_v1
async def sample_generate_application_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateApplicationIaCRequest(
name="name_value",
)
# Make the request
response = await client.generate_application_ia_c(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateApplicationIaCRequest, dict]]
The request object. Request message for GenerateApplicationIaC method. |
name |
Required. The name of the application. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.GenerateApplicationIaCResponse |
Response message for GenerateApplicationIaC method. |
generate_application_template_assessment_report
generate_application_template_assessment_report(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.GenerateApplicationTemplateAssessmentReportRequest,
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.AsyncOperationGenerate Assessment Reports of an application template.
# 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 designcenter_v1
async def sample_generate_application_template_assessment_report():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateApplicationTemplateAssessmentReportRequest(
name="name_value",
)
# Make the request
operation = await client.generate_application_template_assessment_report(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateApplicationTemplateAssessmentReportRequest, dict]]
The request object. Message for generate assessment report application template. |
name |
Required. The application template name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be GenerateApplicationTemplateAssessmentReportResponse Response for GenerateAssessmentReport for application template. |
generate_application_template_ia_c
generate_application_template_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GenerateApplicationTemplateIaCRequest,
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.designcenter_v1.types.authoring_messages.GenerateApplicationTemplateIaCResponse
)Generates Terraform files for an application template. This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.
# 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 designcenter_v1
async def sample_generate_application_template_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateApplicationTemplateIaCRequest(
name="name_value",
)
# Make the request
response = await client.generate_application_template_ia_c(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateApplicationTemplateIaCRequest, dict]]
The request object. Request message for GenerateApplicationTemplateIaC method. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.GenerateApplicationTemplateIaCResponse |
Response message for GenerateApplicationTemplateIaC method. |
generate_application_template_revision_ia_c
generate_application_template_revision_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GenerateApplicationTemplateRevisionIaCRequest,
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.designcenter_v1.types.authoring_messages.GenerateApplicationTemplateRevisionIaCResponse
)Generates Terraform files for an application template revision. This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.
# 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 designcenter_v1
async def sample_generate_application_template_revision_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateApplicationTemplateRevisionIaCRequest(
name="name_value",
)
# Make the request
response = await client.generate_application_template_revision_ia_c(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateApplicationTemplateRevisionIaCRequest, dict]]
The request object. Request message for GenerateApplicationTemplateRevisionIaC method. |
name |
Required. The name of the application template revision. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.GenerateApplicationTemplateRevisionIaCResponse |
Response message for GenerateApplicationTemplateRevisionIaC method. |
generate_assessment_report
generate_assessment_report(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.GenerateAssessmentReportRequest,
dict,
]
] = None,
*,
space_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.AsyncOperationDeprecated: Use GenerateTerraformPlanAssessmentReport instead. Generate a best practice report for a given Terraform plan.
# 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 designcenter_v1
async def sample_generate_assessment_report():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateAssessmentReportRequest(
terraform_plan=b'terraform_plan_blob',
space_name="space_name_value",
)
# Make the request
operation = await client.generate_assessment_report(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateAssessmentReportRequest, dict]]
The request object. Deprecated: Use GenerateTerraformPlanAssessmentReportRequest instead. Message for the request to generate a best practice report for a given Terraform plan. |
space_name |
Required. The name of the space at which Generate Assessment Report is called. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be GenerateAssessmentReportResponse Deprecated: Use GenerateTerraformPlanAssessmentReportResponse instead. Response for GenerateAssessmentReport. |
generate_terraform_plan_assessment_report
generate_terraform_plan_assessment_report(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.GenerateTerraformPlanAssessmentReportRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
terraform_plan: typing.Optional[bytes] = 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.AsyncOperationGenerate a Terraform plan assessment report for a given Terraform plan.
# 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 designcenter_v1
async def sample_generate_terraform_plan_assessment_report():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GenerateTerraformPlanAssessmentReportRequest(
name="name_value",
terraform_plan=b'terraform_plan_blob',
)
# Make the request
operation = await client.generate_terraform_plan_assessment_report(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GenerateTerraformPlanAssessmentReportRequest, dict]]
The request object. Message for the request to generate a best practice report for a given Terraform plan at the collection level. |
name |
Required. The parent resource in which to generate the assessment report. Format: projects/$project/locations/$location/spaces/$space This corresponds to the |
terraform_plan |
Required. The raw JSON representation of the generated Terraform plan, provided as bytes. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be GenerateTerraformPlanAssessmentReportResponse Response for GenerateTerraformPlanAssessmentReport. |
get_application
get_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.GetApplicationRequest,
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.designcenter_v1.types.deployment_resources.ApplicationGets details about an application.
# 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 designcenter_v1
async def sample_get_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetApplicationRequest(
name="name_value",
)
# Make the request
response = await client.get_application(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetApplicationRequest, dict]]
The request object. Message for getting an application. |
name |
Required. The application name. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Application |
Represents the application resource. |
get_application_template
get_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GetApplicationTemplateRequest,
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.designcenter_v1.types.authoring.ApplicationTemplateGets details about an application template.
# 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 designcenter_v1
async def sample_get_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetApplicationTemplateRequest(
name="name_value",
)
# Make the request
response = await client.get_application_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetApplicationTemplateRequest, dict]]
The request object. Message for getting an application template. |
name |
Required. The application template name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplate |
Application template resource. |
get_application_template_revision
get_application_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GetApplicationTemplateRevisionRequest,
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.designcenter_v1.types.authoring.ApplicationTemplateRevisionGets details about an application template 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 designcenter_v1
async def sample_get_application_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetApplicationTemplateRevisionRequest(
name="name_value",
)
# Make the request
response = await client.get_application_template_revision(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetApplicationTemplateRevisionRequest, dict]]
The request object. Message for getting an application template revision. |
name |
Required. The application template revision name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplateRevision |
Application template revision resource. |
get_application_template_system_revision
get_application_template_system_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GetApplicationTemplateSystemRevisionRequest,
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.designcenter_v1.types.authoring.ApplicationTemplateSystemRevisionGets the given application template system 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 designcenter_v1
async def sample_get_application_template_system_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetApplicationTemplateSystemRevisionRequest(
name="name_value",
)
# Make the request
response = await client.get_application_template_system_revision(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetApplicationTemplateSystemRevisionRequest, dict]]
The request object. Message for getting an ApplicationTemplateSystemRevision. |
name |
Required. The name of the ApplicationTemplateSystemRevision to retrieve. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/systemRevisions/{system_revision} This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplateSystemRevision |
Application template system revision resource. |
get_catalog
get_catalog(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.GetCatalogRequest,
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.designcenter_v1.types.catalog_management.CatalogGets details about a catalog.
# 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 designcenter_v1
async def sample_get_catalog():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetCatalogRequest(
name="name_value",
)
# Make the request
response = await client.get_catalog(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetCatalogRequest, dict]]
The request object. Message for getting a catalog. |
name |
Required. The catalog name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Catalog |
A catalog is a collection of templates. |
get_catalog_template
get_catalog_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.GetCatalogTemplateRequest,
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.designcenter_v1.types.catalog_management.CatalogTemplateGets a catalog template.
# 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 designcenter_v1
async def sample_get_catalog_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetCatalogTemplateRequest(
name="name_value",
)
# Make the request
response = await client.get_catalog_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetCatalogTemplateRequest, dict]]
The request object. Message for getting a catalog template resource. |
name |
Required. The catalog template name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.CatalogTemplate |
A template inside a catalog. |
get_catalog_template_revision
get_catalog_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.GetCatalogTemplateRevisionRequest,
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.designcenter_v1.types.catalog_management.CatalogTemplateRevisionGets details about a template 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 designcenter_v1
async def sample_get_catalog_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetCatalogTemplateRevisionRequest(
name="name_value",
)
# Make the request
response = await client.get_catalog_template_revision(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetCatalogTemplateRevisionRequest, dict]]
The request object. Message for GetTemplateRevision Request |
name |
Required. The catalog template revisions name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.CatalogTemplateRevision |
Template revisions inside a catalog. |
get_component
get_component(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GetComponentRequest,
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.designcenter_v1.types.authoring.ComponentGets details about a Component.
# 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 designcenter_v1
async def sample_get_component():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetComponentRequest(
name="name_value",
)
# Make the request
response = await client.get_component(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetComponentRequest, dict]]
The request object. Message for getting a component. |
name |
Required. The component name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Component |
Component resource. |
get_connection
get_connection(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.GetConnectionRequest,
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.designcenter_v1.types.authoring.ConnectionGets details about a connection.
# 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 designcenter_v1
async def sample_get_connection():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetConnectionRequest(
name="name_value",
)
# Make the request
response = await client.get_connection(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetConnectionRequest, dict]]
The request object. Message for getting a connection. |
name |
Required. Name of the resource This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Connection |
Connection resource. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, 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.iam.v1.policy_pb2.PolicyGets 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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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[
typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, 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.location.locations_pb2.LocationGets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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,
)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[
typing.Union[google.longrunning.operations_pb2.GetOperationRequest, 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.longrunning.operations_pb2.OperationGets the latest state of a long-running operation.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
An Operation object. |
get_policy
get_policy(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.GetPolicyRequest,
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.designcenter_v1.types.best_practices.PolicyPolicy related APIs. Get a policy for an application template.
# 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 designcenter_v1
async def sample_get_policy():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetPolicyRequest(
name="name_value",
)
# Make the request
response = await client.get_policy(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetPolicyRequest, dict]]
The request object. Message for getting a policy. |
name |
Required. The policy name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Policy |
A Policy is a resource within an Application Template that refers to a Policy that you author outside of Application Design Center and attach to an application template. |
get_share
get_share(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.GetShareRequest, 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.designcenter_v1.types.sharing.ShareGet catalog share object for the space.
# 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 designcenter_v1
async def sample_get_share():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetShareRequest(
name="name_value",
)
# Make the request
response = await client.get_share(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetShareRequest, dict]]
The request object. Message for getting a share of a catalog. |
name |
Required. The share name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Share |
A catalog share between spaces. |
get_shared_template
get_shared_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.GetSharedTemplateRequest,
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.designcenter_v1.types.sharing.SharedTemplateGets details about a shared template.
# 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 designcenter_v1
async def sample_get_shared_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetSharedTemplateRequest(
name="name_value",
)
# Make the request
response = await client.get_shared_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetSharedTemplateRequest, dict]]
The request object. Message for getting a shared template. |
name |
Required. The shared template name. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.SharedTemplate |
A read-only template that is shared with a space. |
get_shared_template_revision
get_shared_template_revision(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.GetSharedTemplateRevisionRequest,
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.designcenter_v1.types.sharing.SharedTemplateRevisionGets details about a shared template 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 designcenter_v1
async def sample_get_shared_template_revision():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetSharedTemplateRevisionRequest(
name="name_value",
)
# Make the request
response = await client.get_shared_template_revision(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetSharedTemplateRevisionRequest, dict]]
The request object. Message for getting a shared template revisions. |
name |
Required. The shared template revision name, in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.SharedTemplateRevision |
A read-only template revision that is shared with a space. |
get_space
get_space(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.GetSpaceRequest,
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.designcenter_v1.types.catalog_management.SpaceGets details about a space.
# 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 designcenter_v1
async def sample_get_space():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.GetSpaceRequest(
name="name_value",
)
# Make the request
response = await client.get_space(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.GetSpaceRequest, dict]]
The request object. Results returned from projects.locations.spaces.get. |
name |
Required. The space name. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Space |
Space is a top level resource for managing teams building applications through Application Design Center. |
get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.designcenter_v1.services.design_center.transports.base.DesignCenterTransport
]Returns an appropriate transport class.
| Parameter | |
|---|---|
| Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
git_repository_link_path
git_repository_link_path(
project: str, location: str, connection: str, git_repository_link: str
) -> strReturns a fully-qualified git_repository_link string.
import_application_ia_c
import_application_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.ImportApplicationIaCRequest,
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.designcenter_v1.types.deployment_messages.ImportApplicationIaCResponse
)Imports IaC for an application resource.
# 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 designcenter_v1
async def sample_import_application_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ImportApplicationIaCRequest(
gcs_uri="gcs_uri_value",
name="name_value",
)
# Make the request
response = await client.import_application_ia_c(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ImportApplicationIaCRequest, dict]]
The request object. Request message for ImportApplicationIaC method. |
name |
Required. The name of the application. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ImportApplicationIaCResponse |
Response message for ImportApplicationIaC method. |
import_application_template
import_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ImportApplicationTemplateRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
application_template_revision_uri: 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.designcenter_v1.types.authoring.ApplicationTemplateImports to an existing application template from a given shared template.
# 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 designcenter_v1
async def sample_import_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ImportApplicationTemplateRequest(
application_template_revision_uri="application_template_revision_uri_value",
name="name_value",
)
# Make the request
response = await client.import_application_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ImportApplicationTemplateRequest, dict]]
The request object. Request message for ImportApplicationTemplate method. |
name |
Required. The name of the application template. This corresponds to the |
application_template_revision_uri |
Optional. The source URI for application template revision. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplate |
Application template resource. |
import_application_template_ia_c
import_application_template_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ImportApplicationTemplateIaCRequest,
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.designcenter_v1.types.authoring_messages.ImportApplicationTemplateIaCResponse
)Imports IaC for an application template.
# 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 designcenter_v1
async def sample_import_application_template_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ImportApplicationTemplateIaCRequest(
gcs_uri="gcs_uri_value",
name="name_value",
)
# Make the request
response = await client.import_application_template_ia_c(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ImportApplicationTemplateIaCRequest, dict]]
The request object. Request message for ImportApplicationTemplateIaC method. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ImportApplicationTemplateIaCResponse |
Response message for ImportApplicationTemplateIaC method. |
ingest_application_template_ia_c
ingest_application_template_ia_c(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.IngestApplicationTemplateIaCRequest,
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.AsyncOperationIngests IaC for an application template asynchronously.
# 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 designcenter_v1
async def sample_ingest_application_template_ia_c():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.IngestApplicationTemplateIaCRequest(
gcs_uri="gcs_uri_value",
name="name_value",
)
# Make the request
operation = await client.ingest_application_template_ia_c(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.IngestApplicationTemplateIaCRequest, dict]]
The request object. Request message for IngestApplicationTemplateIaC method. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be IngestApplicationTemplateIaCResponse Response message for IngestApplicationTemplateIaC method. |
list_application_template_revisions
list_application_template_revisions(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ListApplicationTemplateRevisionsRequest,
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.designcenter_v1.services.design_center.pagers.ListApplicationTemplateRevisionsAsyncPager
)Lists application template revisions in a given application template.
# 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 designcenter_v1
async def sample_list_application_template_revisions():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListApplicationTemplateRevisionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_application_template_revisions(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListApplicationTemplateRevisionsRequest, dict]]
The request object. Message for requesting a list of application template revisions. |
parent |
Required. The parent from which to list application template revisions. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListApplicationTemplateRevisionsAsyncPager |
Message for response to listing application template revisions. Iterating over this object will yield results and resolve additional pages automatically. |
list_application_template_system_revisions
list_application_template_system_revisions(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ListApplicationTemplateSystemRevisionsRequest,
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.designcenter_v1.services.design_center.pagers.ListApplicationTemplateSystemRevisionsAsyncPager
)Lists application template system revisions in a given application template.
# 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 designcenter_v1
async def sample_list_application_template_system_revisions():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListApplicationTemplateSystemRevisionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_application_template_system_revisions(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListApplicationTemplateSystemRevisionsRequest, dict]]
The request object. Message for requesting a list of application template system revisions. |
parent |
Required. The parent Application Template from which to list the system revisions. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template} This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListApplicationTemplateSystemRevisionsAsyncPager |
Message for response to listing application template system revisions. Iterating over this object will yield results and resolve additional pages automatically. |
list_application_templates
list_application_templates(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ListApplicationTemplatesRequest,
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.designcenter_v1.services.design_center.pagers.ListApplicationTemplatesAsyncPager
)Lists application templates in a given space.
# 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 designcenter_v1
async def sample_list_application_templates():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListApplicationTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_application_templates(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListApplicationTemplatesRequest, dict]]
The request object. Message for requesting a list of application templates. |
parent |
Required. The parent resource from which to list application templates. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListApplicationTemplatesAsyncPager |
Message for response to listing application templates. Iterating over this object will yield results and resolve additional pages automatically. |
list_applications
list_applications(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.ListApplicationsRequest,
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.designcenter_v1.services.design_center.pagers.ListApplicationsAsyncPager
)Lists applications in a given space.
# 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 designcenter_v1
async def sample_list_applications():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListApplicationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_applications(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListApplicationsRequest, dict]]
The request object. Message for requesting a list of applications. |
parent |
Required. The parent resource from which to request a list of applications. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListApplicationsAsyncPager |
Message for response to listing applications. Iterating over this object will yield results and resolve additional pages automatically. |
list_catalog_template_revisions
list_catalog_template_revisions(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.ListCatalogTemplateRevisionsRequest,
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.designcenter_v1.services.design_center.pagers.ListCatalogTemplateRevisionsAsyncPager
)Lists template revisions.
# 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 designcenter_v1
async def sample_list_catalog_template_revisions():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListCatalogTemplateRevisionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalog_template_revisions(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListCatalogTemplateRevisionsRequest, dict]]
The request object. Message for requesting list of template revisions. |
parent |
Required. The parent resource from which a list of catalog template revisions is requested. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListCatalogTemplateRevisionsAsyncPager |
Message for response to listing template revisions. Iterating over this object will yield results and resolve additional pages automatically. |
list_catalog_templates
list_catalog_templates(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.ListCatalogTemplatesRequest,
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.designcenter_v1.services.design_center.pagers.ListCatalogTemplatesAsyncPager
)Lists catalog templates.
# 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 designcenter_v1
async def sample_list_catalog_templates():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListCatalogTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalog_templates(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListCatalogTemplatesRequest, dict]]
The request object. Message for requesting a list of catalog templates. |
parent |
Required. The parent from which the catalog templates are listed in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListCatalogTemplatesAsyncPager |
Message for response to listing catalog templates. Iterating over this object will yield results and resolve additional pages automatically. |
list_catalogs
list_catalogs(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.ListCatalogsRequest,
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.designcenter_v1.services.design_center.pagers.ListCatalogsAsyncPagerLists catalogs in a given space.
# 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 designcenter_v1
async def sample_list_catalogs():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListCatalogsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalogs(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListCatalogsRequest, dict]]
The request object. Message for requesting a list of catalogs. |
parent |
Required. The parent space from which catalogs are listed. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListCatalogsAsyncPager |
Results returned from catalogs.list. Iterating over this object will yield results and resolve additional pages automatically. |
list_components
list_components(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ListComponentsRequest,
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.designcenter_v1.services.design_center.pagers.ListComponentsAsyncPager
)Lists components in an application template.
# 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 designcenter_v1
async def sample_list_components():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListComponentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_components(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListComponentsRequest, dict]]
The request object. Message for requesting a list of components. |
parent |
Required. The parent resource from which the list of components is requested. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListComponentsAsyncPager |
Message for response to listing components. Iterating over this object will yield results and resolve additional pages automatically. |
list_connections
list_connections(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.ListConnectionsRequest,
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.designcenter_v1.services.design_center.pagers.ListConnectionsAsyncPager
)Lists connections in an application template.
# 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 designcenter_v1
async def sample_list_connections():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListConnectionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_connections(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListConnectionsRequest, dict]]
The request object. Message for requesting a list of connections. |
parent |
Required. The parent resource from which to request a list of connections. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListConnectionsAsyncPager |
Message for response to listing connections. Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, 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.location.locations_pb2.ListLocationsResponseLists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Response message for ListLocations method. |
list_operations
list_operations(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, 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.longrunning.operations_pb2.ListOperationsResponseLists operations that match the specified filter in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Response message for ListOperations method. |
list_policies
list_policies(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.ListPoliciesRequest,
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.designcenter_v1.services.design_center.pagers.ListPoliciesAsyncPagerLists policies for an application template.
# 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 designcenter_v1
async def sample_list_policies():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListPoliciesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_policies(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListPoliciesRequest, dict]]
The request object. Message for requesting a list of policies. |
parent |
Required. The parent application template from which policies are listed in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListPoliciesAsyncPager |
Message for response to listing policies. Iterating over this object will yield results and resolve additional pages automatically. |
list_shared_template_revisions
list_shared_template_revisions(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.ListSharedTemplateRevisionsRequest,
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.designcenter_v1.services.design_center.pagers.ListSharedTemplateRevisionsAsyncPager
)Lists shared template revisions in a given space.
# 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 designcenter_v1
async def sample_list_shared_template_revisions():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListSharedTemplateRevisionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_shared_template_revisions(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListSharedTemplateRevisionsRequest, dict]]
The request object. Message for requesting a list of shared template revisions. |
parent |
Required. The parent resource from which to list shared template revisions, in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListSharedTemplateRevisionsAsyncPager |
Message for response to listing shared templates. Iterating over this object will yield results and resolve additional pages automatically. |
list_shared_templates
list_shared_templates(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.ListSharedTemplatesRequest,
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.designcenter_v1.services.design_center.pagers.ListSharedTemplatesAsyncPager
)Lists shared templates in a given space.
# 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 designcenter_v1
async def sample_list_shared_templates():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListSharedTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_shared_templates(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListSharedTemplatesRequest, dict]]
The request object. Message for requesting list of shared templates. |
parent |
Required. The parent space for which shared templates are listed in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListSharedTemplatesAsyncPager |
Message for response to listing shared templates. Iterating over this object will yield results and resolve additional pages automatically. |
list_shares
list_shares(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.ListSharesRequest, 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.designcenter_v1.services.design_center.pagers.ListSharesAsyncPagerLists catalog share objects for the space.
# 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 designcenter_v1
async def sample_list_shares():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListSharesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_shares(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListSharesRequest, dict]]
The request object. Message for listing shares of a catalog. |
parent |
Required. The parent resource from which a list of shares is requested. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListSharesAsyncPager |
Message for response to listing shares of a catalog. Iterating over this object will yield results and resolve additional pages automatically. |
list_spaces
list_spaces(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.ListSpacesRequest,
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.designcenter_v1.services.design_center.pagers.ListSpacesAsyncPagerLists spaces 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 designcenter_v1
async def sample_list_spaces():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.ListSpacesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_spaces(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.ListSpacesRequest, dict]]
The request object. Message for requesting a list of spaces. |
parent |
Required. The name of the parent resource, for which spaces are listed. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.services.design_center.pagers.ListSpacesAsyncPager |
Results returned from projects.locations.spaces.list. Iterating over this object will yield results and resolve additional pages automatically. |
parse_application_path
parse_application_path(path: str) -> typing.Dict[str, str]Parses a application path into its component segments.
parse_application_template_path
parse_application_template_path(path: str) -> typing.Dict[str, str]Parses a application_template path into its component segments.
parse_application_template_revision_path
parse_application_template_revision_path(path: str) -> typing.Dict[str, str]Parses a application_template_revision path into its component segments.
parse_application_template_system_revision_path
parse_application_template_system_revision_path(path: str) -> typing.Dict[str, str]Parses a application_template_system_revision path into its component segments.
parse_catalog_path
parse_catalog_path(path: str) -> typing.Dict[str, str]Parses a catalog path into its component segments.
parse_catalog_template_path
parse_catalog_template_path(path: str) -> typing.Dict[str, str]Parses a catalog_template path into its component segments.
parse_catalog_template_revision_path
parse_catalog_template_revision_path(path: str) -> typing.Dict[str, str]Parses a catalog_template_revision path into its component segments.
parse_cloud_control_path
parse_cloud_control_path(path: str) -> typing.Dict[str, str]Parses a cloud_control path into its component segments.
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_component_path
parse_component_path(path: str) -> typing.Dict[str, str]Parses a component path into its component segments.
parse_connection_path
parse_connection_path(path: str) -> typing.Dict[str, str]Parses a connection path into its component segments.
parse_deployment_group_path
parse_deployment_group_path(path: str) -> typing.Dict[str, str]Parses a deployment_group 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_git_repository_link_path
parse_git_repository_link_path(path: str) -> typing.Dict[str, str]Parses a git_repository_link path into its component segments.
parse_policy_path
parse_policy_path(path: str) -> typing.Dict[str, str]Parses a policy 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_role_path
parse_role_path(path: str) -> typing.Dict[str, str]Parses a role 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_share_path
parse_share_path(path: str) -> typing.Dict[str, str]Parses a share path into its component segments.
parse_shared_template_path
parse_shared_template_path(path: str) -> typing.Dict[str, str]Parses a shared_template path into its component segments.
parse_shared_template_revision_path
parse_shared_template_revision_path(path: str) -> typing.Dict[str, str]Parses a shared_template_revision path into its component segments.
parse_space_path
parse_space_path(path: str) -> typing.Dict[str, str]Parses a space 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.
policy_path
policy_path(
project: str, location: str, space: str, application_template: str, policy: str
) -> strReturns a fully-qualified policy string.
preview_application
preview_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.PreviewApplicationRequest,
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.AsyncOperationPreviews deployment of an application.
# 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 designcenter_v1
async def sample_preview_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.PreviewApplicationRequest(
name="name_value",
)
# Make the request
operation = await client.preview_application(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.PreviewApplicationRequest, dict]]
The request object. Message for previewing an application. |
name |
Required. The application name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be PreviewApplicationResponse Response for PreviewApplication. |
preview_path
preview_path(project: str, location: str, preview: str) -> strReturns a fully-qualified preview string.
recommend_iam_roles
recommend_iam_roles(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.RecommendIAMRolesRequest,
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.AsyncOperationGets recommended IAM roles for an application.
Evaluates the infrastructure resources defined by an application (including its template configuration and parameters) to determine the set of IAM roles and Google Cloud APIs that you must configure before you deploy across target projects.
The operation is asynchronous and returns a
google.longrunning.Operation. Upon completion, the operation
result contains a RecommendIAMRolesResponse with
project-level IAM role and API recommendations.
# 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 designcenter_v1
async def sample_recommend_iam_roles():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.RecommendIAMRolesRequest(
name="name_value",
)
# Make the request
operation = await client.recommend_iam_roles(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.RecommendIAMRolesRequest, dict]]
The request object. Request message for |
name |
Required. The name of the application resource for which to recommend IAM roles. Format: projects/$project/locations/$location/spaces/$space/applications/$application This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RecommendIAMRolesResponse Response message for RecommendIAMRoles. |
register_app_hub_application_resources
register_app_hub_application_resources(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.apphub_integration_messages.RegisterAppHubApplicationResourcesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
apphub_application: typing.Optional[str] = None,
tfstate_content: 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.AsyncOperationRegister deployed resources from terraform state file with App Hub without needing a space.
# 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 designcenter_v1
async def sample_register_app_hub_application_resources():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.RegisterAppHubApplicationResourcesRequest(
tfstate_content="tfstate_content_value",
parent="parent_value",
apphub_application="apphub_application_value",
)
# Make the request
operation = await client.register_app_hub_application_resources(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.RegisterAppHubApplicationResourcesRequest, dict]]
The request object. Request message for RegisterAppHubApplicationResources method. |
parent |
Required. The parent location. Format: projects/{project}/locations/{location} This corresponds to the |
apphub_application |
Required. The name of the AppHub Application. Format: projects/{project}/locations/{location}/applications/{application} This corresponds to the |
tfstate_content |
Optional. The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RegisterAppHubApplicationResourcesResponse Response message for RegisterAppHubApplicationResources method. |
role_path
role_path(organization: str, role: str) -> strReturns a fully-qualified role string.
service_account_path
service_account_path(project: str, service_account: str) -> strReturns a fully-qualified service_account string.
set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, 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.iam.v1.policy_pb2.PolicySets 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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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 __. |
share_path
share_path(
project: str, location: str, space: str, catalog: str, share: str
) -> strReturns a fully-qualified share string.
shared_template_path
shared_template_path(
project: str, location: str, space: str, shared_template: str
) -> strReturns a fully-qualified shared_template string.
shared_template_revision_path
shared_template_revision_path(
project: str, location: str, space: str, shared_template: str, revision: str
) -> strReturns a fully-qualified shared_template_revision string.
snapshot_application_template
snapshot_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.SnapshotApplicationTemplateRequest,
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.AsyncOperationSnapshots an application template to create a new revision asynchronously.
# 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 designcenter_v1
async def sample_snapshot_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.SnapshotApplicationTemplateRequest(
name="name_value",
)
# Make the request
operation = await client.snapshot_application_template(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.SnapshotApplicationTemplateRequest, dict]]
The request object. Message for snapshotting an application template asynchronously. |
name |
Required. The name of the application template. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be SnapshotApplicationTemplateResponse Response message for snapshotting an application template asynchronously. |
space_path
space_path(project: str, location: str, space: str) -> strReturns a fully-qualified space string.
sync_share
sync_share(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.sharing_messages.SyncShareRequest, 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.AsyncOperationSynchronizes a share and updates the destination workspace to reflect. reflect the most recent changes to the catalog.
# 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 designcenter_v1
async def sample_sync_share():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.SyncShareRequest(
name="name_value",
)
# Make the request
operation = await client.sync_share(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.SyncShareRequest, dict]]
The request object. Message for syncing a share of a catalog. |
name |
Required. The share name in the following format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Share A catalog share between spaces. |
test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, 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.iam.v1.iam_policy_pb2.TestIamPermissionsResponseTests 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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Response message for TestIamPermissions method. |
update_application
update_application(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.deployment_messages.UpdateApplicationRequest,
dict,
]
] = None,
*,
application: typing.Optional[
google.cloud.designcenter_v1.types.deployment_resources.Application
] = 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.designcenter_v1.types.deployment_resources.ApplicationUpdates an application.
# 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 designcenter_v1
async def sample_update_application():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
application = designcenter_v1.Application()
application.source.application_template_revision = "application_template_revision_value"
application.scope.type_ = "GLOBAL"
request = designcenter_v1.UpdateApplicationRequest(
application=application,
)
# Make the request
response = await client.update_application(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateApplicationRequest, dict]]
The request object. Message for updating an application. |
application |
Application
Required. The application to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the application update. If you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Application |
Represents the application resource. |
update_application_template
update_application_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.UpdateApplicationTemplateRequest,
dict,
]
] = None,
*,
application_template: typing.Optional[
google.cloud.designcenter_v1.types.authoring.ApplicationTemplate
] = 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.designcenter_v1.types.authoring.ApplicationTemplateUpdates an application template.
# 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 designcenter_v1
async def sample_update_application_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.UpdateApplicationTemplateRequest(
)
# Make the request
response = await client.update_application_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateApplicationTemplateRequest, dict]]
The request object. Message for updating an application template. |
application_template |
ApplicationTemplate
Required. The application template to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the application template 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 you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.ApplicationTemplate |
Application template resource. |
update_catalog
update_catalog(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.UpdateCatalogRequest,
dict,
]
] = None,
*,
catalog: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.Catalog
] = 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.designcenter_v1.types.catalog_management.CatalogUpdates a catalog.
# 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 designcenter_v1
async def sample_update_catalog():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.UpdateCatalogRequest(
)
# Make the request
response = await client.update_catalog(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateCatalogRequest, dict]]
The request object. Message for updating a catalog. |
catalog |
Catalog
Required. The catalog to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the catalog update. If you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Catalog |
A catalog is a collection of templates. |
update_catalog_template
update_catalog_template(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.UpdateCatalogTemplateRequest,
dict,
]
] = None,
*,
catalog_template: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.CatalogTemplate
] = 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.designcenter_v1.types.catalog_management.CatalogTemplateUpdates a catalog template resource.
# 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 designcenter_v1
async def sample_update_catalog_template():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
catalog_template = designcenter_v1.CatalogTemplate()
catalog_template.template_category = "INSTANCE_TEMPLATE"
request = designcenter_v1.UpdateCatalogTemplateRequest(
catalog_template=catalog_template,
)
# Make the request
response = await client.update_catalog_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateCatalogTemplateRequest, dict]]
The request object. Message for updating a catalog template. |
catalog_template |
CatalogTemplate
Required. The catalog template to update. Format: |
update_mask |
Optional. The fields to overwrite in the catalog template 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 you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.CatalogTemplate |
A template inside a catalog. |
update_component
update_component(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.UpdateComponentRequest,
dict,
]
] = None,
*,
component: typing.Optional[
google.cloud.designcenter_v1.types.authoring.Component
] = 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.designcenter_v1.types.authoring.ComponentUpdates a component.
# 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 designcenter_v1
async def sample_update_component():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
component = designcenter_v1.Component()
component.shared_template_revision_uri = "shared_template_revision_uri_value"
request = designcenter_v1.UpdateComponentRequest(
component=component,
)
# Make the request
response = await client.update_component(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateComponentRequest, dict]]
The request object. Message for updating a component. |
component |
Component
Required. The component to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the component update. If you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Component |
Component resource. |
update_connection
update_connection(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.authoring_messages.UpdateConnectionRequest,
dict,
]
] = None,
*,
connection: typing.Optional[
google.cloud.designcenter_v1.types.authoring.Connection
] = 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.designcenter_v1.types.authoring.ConnectionUpdates a connection.
# 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 designcenter_v1
async def sample_update_connection():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
connection = designcenter_v1.Connection()
connection.destination_component_uri = "destination_component_uri_value"
request = designcenter_v1.UpdateConnectionRequest(
connection=connection,
)
# Make the request
response = await client.update_connection(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateConnectionRequest, dict]]
The request object. Message for updating a connection. |
connection |
Connection
Required. The connection to update. This corresponds to the |
update_mask |
Optional. Fields to overwrite in the connection 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 you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Connection |
Connection resource. |
update_policy
update_policy(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.best_practices_messages.UpdatePolicyRequest,
dict,
]
] = None,
*,
policy: typing.Optional[
google.cloud.designcenter_v1.types.best_practices.Policy
] = 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.designcenter_v1.types.best_practices.PolicyUpdates a policy.
# 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 designcenter_v1
async def sample_update_policy():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
policy = designcenter_v1.Policy()
policy.policy_uri = "policy_uri_value"
policy.policy_type = "COMPLIANCE_FRAMEWORK"
request = designcenter_v1.UpdatePolicyRequest(
policy=policy,
)
# Make the request
response = await client.update_policy(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdatePolicyRequest, dict]]
The request object. Message for updating a policy. |
policy |
Policy
Required. The policy to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the policy 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 you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Policy |
A Policy is a resource within an Application Template that refers to a Policy that you author outside of Application Design Center and attach to an application template. |
update_space
update_space(
request: typing.Optional[
typing.Union[
google.cloud.designcenter_v1.types.catalog_management_messages.UpdateSpaceRequest,
dict,
]
] = None,
*,
space: typing.Optional[
google.cloud.designcenter_v1.types.catalog_management.Space
] = 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.designcenter_v1.types.catalog_management.SpaceUpdates a space.
# 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 designcenter_v1
async def sample_update_space():
# Create a client
client = designcenter_v1.DesignCenterAsyncClient()
# Initialize request argument(s)
request = designcenter_v1.UpdateSpaceRequest(
)
# Make the request
response = await client.update_space(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.designcenter_v1.types.UpdateSpaceRequest, dict]]
The request object. Message for updating a space. |
space |
Space
Required. The space to update. This corresponds to the |
update_mask |
Optional. The fields to overwrite in the space update. If you don't provide a mask, all fields are overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.designcenter_v1.types.Space |
Space is a top level resource for managing teams building applications through Application Design Center. |
worker_pool_path
worker_pool_path(project: str, location: str, worker_pool: str) -> strReturns a fully-qualified worker_pool string.