Design Center V1 API - Class Google::Cloud::DesignCenter::V1::DesignCenter::Client (v0.1.0)

Reference documentation and code samples for the Design Center V1 API class Google::Cloud::DesignCenter::V1::DesignCenter::Client.

Client for the DesignCenter service.

Service describing handlers for resources

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DesignCenter Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DesignCenter clients
::Google::Cloud::DesignCenter::V1::DesignCenter::Client.configure do |config|
  config.timeout = 10.0
end

#commit_application_template

def commit_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
def commit_application_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision

Commits an application template to create a new revision.

Overloads 
def commit_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
Pass arguments to commit_application_template via a request object, either of type CommitApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CommitApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def commit_application_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
Pass arguments to commit_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the application template.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CommitApplicationTemplateRequest.new

# Call the commit_application_template method.
result = client.commit_application_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the DesignCenter Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_application

def create_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
def create_application(parent: nil, application_id: nil, application: nil) -> ::Google::Cloud::DesignCenter::V1::Application

Creates an application.

Overloads 
def create_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to create_application via a request object, either of type CreateApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_application(parent: nil, application_id: nil, application: nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to create_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which to create the application. Format: projects/$project/locations/$location/spaces/$space
  • application_id (::String) — Required. The ID of the application to create.
  • application (::Google::Cloud::DesignCenter::V1::Application, ::Hash) — Required. The application to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateApplicationRequest.new

# Call the create_application method.
result = client.create_application request

# The returned object is of type Google::Cloud::DesignCenter::V1::Application.
p result

#create_application_template

def create_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
def create_application_template(parent: nil, application_template_id: nil, application_template: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate

Creates an application template.

Overloads 
def create_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to create_application_template via a request object, either of type CreateApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_application_template(parent: nil, application_template_id: nil, application_template: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to create_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which to create the application template.
  • application_template_id (::String) — Required. The ID of the application template to create.
  • application_template (::Google::Cloud::DesignCenter::V1::ApplicationTemplate, ::Hash) — Required. The application template to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateApplicationTemplateRequest.new

# Call the create_application_template method.
result = client.create_application_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplate.
p result

#create_catalog

def create_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
def create_catalog(parent: nil, catalog_id: nil, catalog: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog

Creates a catalog.

Overloads 
def create_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to create_catalog via a request object, either of type CreateCatalogRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateCatalogRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_catalog(parent: nil, catalog_id: nil, catalog: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to create_catalog via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent space in which a catalog is created in the following format: projects/$project/locations/$location/spaces/$space
  • catalog_id (::String) — Required. The ID of the catalog to create.
  • catalog (::Google::Cloud::DesignCenter::V1::Catalog, ::Hash) — Required. The catalog to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateCatalogRequest.new

# Call the create_catalog method.
result = client.create_catalog request

# The returned object is of type Google::Cloud::DesignCenter::V1::Catalog.
p result

#create_catalog_template

def create_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
def create_catalog_template(parent: nil, catalog_template_id: nil, catalog_template: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate

Adds a template to a catalog.

Overloads 
def create_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to create_catalog_template via a request object, either of type CreateCatalogTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateCatalogTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_catalog_template(parent: nil, catalog_template_id: nil, catalog_template: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to create_catalog_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which the catalog template is created.
  • catalog_template_id (::String) — Required. The ID of the catalog template to create. The ID is appended to the catalog template's name.
  • catalog_template (::Google::Cloud::DesignCenter::V1::CatalogTemplate, ::Hash) — Required. The catalog template to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateCatalogTemplateRequest.new

# Call the create_catalog_template method.
result = client.create_catalog_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::CatalogTemplate.
p result

#create_catalog_template_revision

def create_catalog_template_revision(request, options = nil) -> ::Gapic::Operation
def create_catalog_template_revision(parent: nil, catalog_template_revision_id: nil, catalog_template_revision: nil) -> ::Gapic::Operation

Creates a template revision.

Overloads 
def create_catalog_template_revision(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_catalog_template_revision via a request object, either of type CreateCatalogTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateCatalogTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_catalog_template_revision(parent: nil, catalog_template_revision_id: nil, catalog_template_revision: nil) -> ::Gapic::Operation
Pass arguments to create_catalog_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent in which the catalog template revisions request is created in following format: projects/$project/locations/$location/spaces/$space/templates/$template
  • catalog_template_revision_id (::String) — Required. The ID of the template revision to create.
  • catalog_template_revision (::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision, ::Hash) — Required. The template revision to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateCatalogTemplateRevisionRequest.new

# Call the create_catalog_template_revision method.
result = client.create_catalog_template_revision request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_component

def create_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
def create_component(parent: nil, component_id: nil, component: nil) -> ::Google::Cloud::DesignCenter::V1::Component

Creates a component.

Overloads 
def create_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to create_component via a request object, either of type CreateComponentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateComponentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_component(parent: nil, component_id: nil, component: nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to create_component via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which to create the component.
  • component_id (::String) — Required. The ID of the component to create.
  • component (::Google::Cloud::DesignCenter::V1::Component, ::Hash) — Required. The component to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateComponentRequest.new

# Call the create_component method.
result = client.create_component request

# The returned object is of type Google::Cloud::DesignCenter::V1::Component.
p result

#create_connection

def create_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
def create_connection(parent: nil, connection_id: nil, connection: nil) -> ::Google::Cloud::DesignCenter::V1::Connection

Creates a connection.

Overloads 
def create_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to create_connection via a request object, either of type CreateConnectionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_connection(parent: nil, connection_id: nil, connection: nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to create_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which to create a connection.
  • connection_id (::String) — Required. The ID of the connection to create.
  • connection (::Google::Cloud::DesignCenter::V1::Connection, ::Hash) — Required. The connection to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateConnectionRequest.new

# Call the create_connection method.
result = client.create_connection request

# The returned object is of type Google::Cloud::DesignCenter::V1::Connection.
p result

#create_policy

def create_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
def create_policy(parent: nil, policy_id: nil, policy: nil) -> ::Google::Cloud::DesignCenter::V1::Policy

Creates a policy for an application template.

Overloads 
def create_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to create_policy via a request object, either of type CreatePolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreatePolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_policy(parent: nil, policy_id: nil, policy: nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to create_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which to create the policy in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate
  • policy_id (::String) — Required. The ID of the policy to create.
  • policy (::Google::Cloud::DesignCenter::V1::Policy, ::Hash) — Required. The policy to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreatePolicyRequest.new

# Call the create_policy method.
result = client.create_policy request

# The returned object is of type Google::Cloud::DesignCenter::V1::Policy.
p result

#create_share

def create_share(request, options = nil) -> ::Gapic::Operation
def create_share(parent: nil, share_id: nil, share: nil) -> ::Gapic::Operation

Shares a catalog from one space to another space.

Overloads 
def create_share(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_share via a request object, either of type CreateShareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateShareRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_share(parent: nil, share_id: nil, share: nil) -> ::Gapic::Operation
Pass arguments to create_share via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource in which shares are created.
  • share_id (::String) — Required. The ID of the share to create.
  • share (::Google::Cloud::DesignCenter::V1::Share, ::Hash) — Required. The share to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateShareRequest.new

# Call the create_share method.
result = client.create_share request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_space

def create_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
def create_space(parent: nil, space_id: nil, space: nil) -> ::Google::Cloud::DesignCenter::V1::Space

Creates a space.

Overloads 
def create_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to create_space via a request object, either of type CreateSpaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::CreateSpaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_space(parent: nil, space_id: nil, space: nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to create_space via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent in which to create a space.
  • space_id (::String) — Required. The ID of the space to create.
  • space (::Google::Cloud::DesignCenter::V1::Space, ::Hash) — Required. The space to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::CreateSpaceRequest.new

# Call the create_space method.
result = client.create_space request

# The returned object is of type Google::Cloud::DesignCenter::V1::Space.
p result

#delete_application

def delete_application(request, options = nil) -> ::Gapic::Operation
def delete_application(name: nil, force: nil) -> ::Gapic::Operation

Deletes an application.

Overloads 
def delete_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_application via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_application(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application
  • force (::Boolean) — Optional. If set to true, the application's children are also deleted. If false, the application is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteApplicationRequest.new

# Call the delete_application method.
result = client.delete_application request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_application_template

def delete_application_template(request, options = nil) -> ::Google::Protobuf::Empty
def delete_application_template(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes an application template.

Overloads 
def delete_application_template(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_application_template via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_application_template(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The application template name.
  • force (::Boolean) — Optional. If set to true, the application template's children are also deleted. If false, the application template is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRequest.new

# Call the delete_application_template method.
result = client.delete_application_template request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_application_template_revision

def delete_application_template_revision(request, options = nil) -> ::Google::Protobuf::Empty
def delete_application_template_revision(name: nil) -> ::Google::Protobuf::Empty

Deletes an application template revision.

Overloads 
def delete_application_template_revision(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_application_template_revision via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_application_template_revision(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_application_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application template revision name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteApplicationTemplateRevisionRequest.new

# Call the delete_application_template_revision method.
result = client.delete_application_template_revision request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_catalog

def delete_catalog(request, options = nil) -> ::Gapic::Operation
def delete_catalog(name: nil, force: nil) -> ::Gapic::Operation

Deletes a catalog.

Overloads 
def delete_catalog(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_catalog via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteCatalogRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteCatalogRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_catalog(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_catalog via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
  • force (::Boolean) — Optional. If set to true, the catalog's children are also deleted. If false, the catalog is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteCatalogRequest.new

# Call the delete_catalog method.
result = client.delete_catalog request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_catalog_template

def delete_catalog_template(request, options = nil) -> ::Gapic::Operation
def delete_catalog_template(name: nil, force: nil) -> ::Gapic::Operation

Deletes a catalog template.

Overloads 
def delete_catalog_template(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_catalog_template via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_catalog_template(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_catalog_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The catalog template name. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
  • force (::Boolean) — Optional. If set to true, the catalog template's children are also deleted. If false, the catalog template is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRequest.new

# Call the delete_catalog_template method.
result = client.delete_catalog_template request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_catalog_template_revision

def delete_catalog_template_revision(request, options = nil) -> ::Gapic::Operation
def delete_catalog_template_revision(name: nil) -> ::Gapic::Operation

Deletes a template revision.

Overloads 
def delete_catalog_template_revision(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_catalog_template_revision via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_catalog_template_revision(name: nil) -> ::Gapic::Operation
Pass arguments to delete_catalog_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The template revision name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteCatalogTemplateRevisionRequest.new

# Call the delete_catalog_template_revision method.
result = client.delete_catalog_template_revision request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_component

def delete_component(request, options = nil) -> ::Google::Protobuf::Empty
def delete_component(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes a component.

Overloads 
def delete_component(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_component via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteComponentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteComponentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_component(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_component via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The component name.
  • force (::Boolean) — Optional. If set to true, the component's children are also deleted. If false, the component is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteComponentRequest.new

# Call the delete_component method.
result = client.delete_component request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_connection

def delete_connection(request, options = nil) -> ::Google::Protobuf::Empty
def delete_connection(name: nil) -> ::Google::Protobuf::Empty

Deletes a connection.

Overloads 
def delete_connection(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_connection via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteConnectionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_connection(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The connection name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteConnectionRequest.new

# Call the delete_connection method.
result = client.delete_connection request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_policy

def delete_policy(request, options = nil) -> ::Google::Protobuf::Empty
def delete_policy(name: nil) -> ::Google::Protobuf::Empty

Deletes a policy.

Overloads 
def delete_policy(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_policy via a request object, either of type Google::Cloud::DesignCenter::V1::DeletePolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeletePolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_policy(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeletePolicyRequest.new

# Call the delete_policy method.
result = client.delete_policy request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_share

def delete_share(request, options = nil) -> ::Gapic::Operation
def delete_share(name: nil) -> ::Gapic::Operation

Deletes a catalog share.

Overloads 
def delete_share(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_share via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteShareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteShareRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_share(name: nil) -> ::Gapic::Operation
Pass arguments to delete_share via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteShareRequest.new

# Call the delete_share method.
result = client.delete_share request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_space

def delete_space(request, options = nil) -> ::Google::Protobuf::Empty
def delete_space(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes a space.

Overloads 
def delete_space(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_space via a request object, either of type Google::Cloud::DesignCenter::V1::DeleteSpaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeleteSpaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_space(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_space via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The space name.
  • force (::Boolean) — Optional. If set to true, the space's children are also deleted. If false, the space is only deleted if it has no children.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeleteSpaceRequest.new

# Call the delete_space method.
result = client.delete_space request

# The returned object is of type Google::Protobuf::Empty.
p result

#deploy_application

def deploy_application(request, options = nil) -> ::Gapic::Operation
def deploy_application(name: nil, replace: nil, worker_pool: nil, service_account: nil, validate_only: nil) -> ::Gapic::Operation

Deploys an application.

Overloads 
def deploy_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to deploy_application via a request object, either of type Google::Cloud::DesignCenter::V1::DeployApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::DeployApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def deploy_application(name: nil, replace: nil, worker_pool: nil, service_account: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to deploy_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application
  • replace (::Boolean) — Optional. Flag to update the existing deployment. If not set or false, deploy will fail if application state is in the DEPLOYED state.
  • worker_pool (::String) — Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application.
  • service_account (::String) —

    Optional. The email address of the service account to use for this deployment.

    • If provided, this service account will be used to execute the deployment process, taking precedence over any service_account specified on the Application resource.
    • The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
    • If this field is omitted, the system will use the 'service_account' defined within the Application resource.
    • We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the deployment will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}
  • validate_only (::Boolean) — Optional. If set to true, the request is validated, but no actual deployment will occur. See https://google.aip.dev/163 for more details.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::DeployApplicationRequest.new

# Call the deploy_application method.
result = client.deploy_application request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#export_application_ia_c

def export_application_ia_c(request, options = nil) -> ::Gapic::Operation
def export_application_ia_c(name: nil, iac_format: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation

Exports Terraform files for an application asynchronously.

Overloads 
def export_application_ia_c(request, options = nil) -> ::Gapic::Operation
Pass arguments to export_application_ia_c via a request object, either of type ExportApplicationIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ExportApplicationIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def export_application_ia_c(name: nil, iac_format: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation
Pass arguments to export_application_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ExportApplicationIaCRequest.new

# Call the export_application_ia_c method.
result = client.export_application_ia_c request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#export_application_template_ia_c

def export_application_template_ia_c(request, options = nil) -> ::Gapic::Operation
def export_application_template_ia_c(name: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation

Exports 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.

Overloads 
def export_application_template_ia_c(request, options = nil) -> ::Gapic::Operation
Pass arguments to export_application_template_ia_c via a request object, either of type ExportApplicationTemplateIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ExportApplicationTemplateIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def export_application_template_ia_c(name: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation
Pass arguments to export_application_template_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ExportApplicationTemplateIaCRequest.new

# Call the export_application_template_ia_c method.
result = client.export_application_template_ia_c request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#export_application_template_revision_ia_c

def export_application_template_revision_ia_c(request, options = nil) -> ::Gapic::Operation
def export_application_template_revision_ia_c(name: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation

Exports 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.

Overloads 
def export_application_template_revision_ia_c(request, options = nil) -> ::Gapic::Operation
Pass arguments to export_application_template_revision_ia_c via a request object, either of type ExportApplicationTemplateRevisionIaCRequest or an equivalent Hash.
Parameters 
def export_application_template_revision_ia_c(name: nil, artifact_location: nil, export_iac_config: nil) -> ::Gapic::Operation
Pass arguments to export_application_template_revision_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ExportApplicationTemplateRevisionIaCRequest.new

# Call the export_application_template_revision_ia_c method.
result = client.export_application_template_revision_ia_c request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#fetch_application_assessment_report

def fetch_application_assessment_report(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportResponse
def fetch_application_assessment_report(name: nil) -> ::Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportResponse

Fetches the assessment report of a deployed application if present.

Overloads 
def fetch_application_assessment_report(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportResponse
Pass arguments to fetch_application_assessment_report via a request object, either of type FetchApplicationAssessmentReportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def fetch_application_assessment_report(name: nil) -> ::Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportResponse
Pass arguments to fetch_application_assessment_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportRequest.new

# Call the fetch_application_assessment_report method.
result = client.fetch_application_assessment_report request

# The returned object is of type Google::Cloud::DesignCenter::V1::FetchApplicationAssessmentReportResponse.
p result

#fetch_frameworks

def fetch_frameworks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Framework>
def fetch_frameworks(parent: nil, projects: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Framework>

Fetches all frameworks for assessment report.

Overloads 
def fetch_frameworks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Framework>
Pass arguments to fetch_frameworks via a request object, either of type FetchFrameworksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::FetchFrameworksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def fetch_frameworks(parent: nil, projects: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Framework>
Pass arguments to fetch_frameworks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name. Format: projects/{project}/locations/{location}
  • projects (::Array<::String>) — Optional. Projects to fetch frameworks for. Format: projects/{project}
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. Filter for frameworks list.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::FetchFrameworksRequest.new

# Call the fetch_frameworks method.
result = client.fetch_frameworks request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Framework.
  p item
end

#generate_application_assessment_report

def generate_application_assessment_report(request, options = nil) -> ::Gapic::Operation
def generate_application_assessment_report(name: nil) -> ::Gapic::Operation

Generate Assessment Reports of an application.

Overloads 
def generate_application_assessment_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to generate_application_assessment_report via a request object, either of type GenerateApplicationAssessmentReportRequest or an equivalent Hash.
Parameters 
def generate_application_assessment_report(name: nil) -> ::Gapic::Operation
Pass arguments to generate_application_assessment_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateApplicationAssessmentReportRequest.new

# Call the generate_application_assessment_report method.
result = client.generate_application_assessment_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_application_ia_c

def generate_application_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationIaCResponse
def generate_application_ia_c(name: nil, iac_format: nil, gcs_uri: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationIaCResponse

Generates Terraform files for an application.

Overloads 
def generate_application_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationIaCResponse
Pass arguments to generate_application_ia_c via a request object, either of type GenerateApplicationIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GenerateApplicationIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_application_ia_c(name: nil, iac_format: nil, gcs_uri: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationIaCResponse
Pass arguments to generate_application_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the application.
  • iac_format (::Google::Cloud::DesignCenter::V1::IACFormat) — Optional. The IaC format to generate.
  • gcs_uri (::String) — Optional. DEPRECATED: Use the 'artifact_location' field instead. The Cloud Storage URI to write the generated IaC to.
  • artifact_location (::Google::Cloud::DesignCenter::V1::ArtifactLocation, ::Hash) — Optional. Specifies the destination for the generated IaC, which can be Cloud Storage or a Developer Connect repository.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateApplicationIaCRequest.new

# Call the generate_application_ia_c method.
result = client.generate_application_ia_c request

# The returned object is of type Google::Cloud::DesignCenter::V1::GenerateApplicationIaCResponse.
p result

#generate_application_template_assessment_report

def generate_application_template_assessment_report(request, options = nil) -> ::Gapic::Operation
def generate_application_template_assessment_report(name: nil, service_account: nil) -> ::Gapic::Operation

Generate Assessment Reports of an application template.

Overloads 
def generate_application_template_assessment_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to generate_application_template_assessment_report via a request object, either of type GenerateApplicationTemplateAssessmentReportRequest or an equivalent Hash.
Parameters 
def generate_application_template_assessment_report(name: nil, service_account: nil) -> ::Gapic::Operation
Pass arguments to generate_application_template_assessment_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The application template name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate
  • service_account (::String) —

    Optional. Deprecated: This field is no longer used since we moved to fast plan assessment.

    • This service account will be used to execute the preview process.
    • The caller must have the 'iam.serviceAccounts.actAs' permission on this service account. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateAssessmentReportRequest.new

# Call the generate_application_template_assessment_report method.
result = client.generate_application_template_assessment_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_application_template_ia_c

def generate_application_template_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCResponse
def generate_application_template_ia_c(name: nil, iac_format: nil, gcs_uri: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::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.

Overloads 
def generate_application_template_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCResponse
Pass arguments to generate_application_template_ia_c via a request object, either of type GenerateApplicationTemplateIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_application_template_ia_c(name: nil, iac_format: nil, gcs_uri: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCResponse
Pass arguments to generate_application_template_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCRequest.new

# Call the generate_application_template_ia_c method.
result = client.generate_application_template_ia_c request

# The returned object is of type Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateIaCResponse.
p result

#generate_application_template_revision_ia_c

def generate_application_template_revision_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateRevisionIaCResponse
def generate_application_template_revision_ia_c(name: nil, iac_format: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::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.

Overloads 
def generate_application_template_revision_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateRevisionIaCResponse
Pass arguments to generate_application_template_revision_ia_c via a request object, either of type GenerateApplicationTemplateRevisionIaCRequest or an equivalent Hash.
Parameters 
def generate_application_template_revision_ia_c(name: nil, iac_format: nil, artifact_location: nil) -> ::Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateRevisionIaCResponse
Pass arguments to generate_application_template_revision_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateRevisionIaCRequest.new

# Call the generate_application_template_revision_ia_c method.
result = client.generate_application_template_revision_ia_c request

# The returned object is of type Google::Cloud::DesignCenter::V1::GenerateApplicationTemplateRevisionIaCResponse.
p result

#generate_assessment_report

def generate_assessment_report(request, options = nil) -> ::Gapic::Operation
def generate_assessment_report(terraform_plan: nil, additional_frameworks: nil, space_name: nil) -> ::Gapic::Operation

Deprecated: Use GenerateTerraformPlanAssessmentReport instead.

Generate a best practice report for a given Terraform plan.

Overloads 
def generate_assessment_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to generate_assessment_report via a request object, either of type GenerateAssessmentReportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GenerateAssessmentReportRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_assessment_report(terraform_plan: nil, additional_frameworks: nil, space_name: nil) -> ::Gapic::Operation
Pass arguments to generate_assessment_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • terraform_plan (::String) — Required. Terraform plan bytes.
  • additional_frameworks (::Array<::String>) — Optional. Additional Frameworks to run assessment against. If empty, run against default frameworks. Frameworks refers to the policies.
  • space_name (::String) — Required. The name of the space at which Generate Assessment Report is called. Format: projects/$project/locations/$location/spaces/$space
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateAssessmentReportRequest.new

# Call the generate_assessment_report method.
result = client.generate_assessment_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_terraform_plan_assessment_report

def generate_terraform_plan_assessment_report(request, options = nil) -> ::Gapic::Operation
def generate_terraform_plan_assessment_report(name: nil, terraform_plan: nil, additional_frameworks: nil) -> ::Gapic::Operation

Generate a Terraform plan assessment report for a given Terraform plan.

Overloads 
def generate_terraform_plan_assessment_report(request, options = nil) -> ::Gapic::Operation
Pass arguments to generate_terraform_plan_assessment_report via a request object, either of type GenerateTerraformPlanAssessmentReportRequest or an equivalent Hash.
Parameters 
def generate_terraform_plan_assessment_report(name: nil, terraform_plan: nil, additional_frameworks: nil) -> ::Gapic::Operation
Pass arguments to generate_terraform_plan_assessment_report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The parent resource in which to generate the assessment report. Format: projects/$project/locations/$location/spaces/$space
  • terraform_plan (::String) — Required. The raw JSON representation of the generated Terraform plan, provided as bytes.
  • additional_frameworks (::Array<::String>) — Optional. Additional Frameworks to run assessment against. If empty, run against default frameworks. Frameworks refers to the policies.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GenerateTerraformPlanAssessmentReportRequest.new

# Call the generate_terraform_plan_assessment_report method.
result = client.generate_terraform_plan_assessment_report request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_application

def get_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
def get_application(name: nil) -> ::Google::Cloud::DesignCenter::V1::Application

Gets details about an application.

Overloads 
def get_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to get_application via a request object, either of type GetApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_application(name: nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to get_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetApplicationRequest.new

# Call the get_application method.
result = client.get_application request

# The returned object is of type Google::Cloud::DesignCenter::V1::Application.
p result

#get_application_template

def get_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
def get_application_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate

Gets details about an application template.

Overloads 
def get_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to get_application_template via a request object, either of type GetApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_application_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to get_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application template name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetApplicationTemplateRequest.new

# Call the get_application_template method.
result = client.get_application_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplate.
p result

#get_application_template_revision

def get_application_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
def get_application_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision

Gets details about an application template revision.

Overloads 
def get_application_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
Pass arguments to get_application_template_revision via a request object, either of type GetApplicationTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetApplicationTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_application_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision
Pass arguments to get_application_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The application template revision name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetApplicationTemplateRevisionRequest.new

# Call the get_application_template_revision method.
result = client.get_application_template_revision request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision.
p result

#get_application_template_system_revision

def get_application_template_system_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision
def get_application_template_system_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision

Gets the given application template system revision.

Overloads 
def get_application_template_system_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision
Pass arguments to get_application_template_system_revision via a request object, either of type GetApplicationTemplateSystemRevisionRequest or an equivalent Hash.
Parameters 
def get_application_template_system_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision
Pass arguments to get_application_template_system_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the ApplicationTemplateSystemRevision to retrieve. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/systemRevisions/{system_revision}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetApplicationTemplateSystemRevisionRequest.new

# Call the get_application_template_system_revision method.
result = client.get_application_template_system_revision request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision.
p result

#get_catalog

def get_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
def get_catalog(name: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog

Gets details about a catalog.

Overloads 
def get_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to get_catalog via a request object, either of type GetCatalogRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetCatalogRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_catalog(name: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to get_catalog via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetCatalogRequest.new

# Call the get_catalog method.
result = client.get_catalog request

# The returned object is of type Google::Cloud::DesignCenter::V1::Catalog.
p result

#get_catalog_template

def get_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
def get_catalog_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate

Gets a catalog template.

Overloads 
def get_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to get_catalog_template via a request object, either of type GetCatalogTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetCatalogTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_catalog_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to get_catalog_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The catalog template name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetCatalogTemplateRequest.new

# Call the get_catalog_template method.
result = client.get_catalog_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::CatalogTemplate.
p result

#get_catalog_template_revision

def get_catalog_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision
def get_catalog_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision

Gets details about a template revision.

Overloads 
def get_catalog_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision
Pass arguments to get_catalog_template_revision via a request object, either of type GetCatalogTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetCatalogTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_catalog_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision
Pass arguments to get_catalog_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The catalog template revisions name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetCatalogTemplateRevisionRequest.new

# Call the get_catalog_template_revision method.
result = client.get_catalog_template_revision request

# The returned object is of type Google::Cloud::DesignCenter::V1::CatalogTemplateRevision.
p result

#get_component

def get_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
def get_component(name: nil) -> ::Google::Cloud::DesignCenter::V1::Component

Gets details about a Component.

Overloads 
def get_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to get_component via a request object, either of type GetComponentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetComponentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_component(name: nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to get_component via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The component name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetComponentRequest.new

# Call the get_component method.
result = client.get_component request

# The returned object is of type Google::Cloud::DesignCenter::V1::Component.
p result

#get_connection

def get_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
def get_connection(name: nil) -> ::Google::Cloud::DesignCenter::V1::Connection

Gets details about a connection.

Overloads 
def get_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to get_connection via a request object, either of type GetConnectionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_connection(name: nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to get_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetConnectionRequest.new

# Call the get_connection method.
result = client.get_connection request

# The returned object is of type Google::Cloud::DesignCenter::V1::Connection.
p result

#get_policy

def get_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
def get_policy(name: nil) -> ::Google::Cloud::DesignCenter::V1::Policy

Policy related APIs. Get a policy for an application template.

Overloads 
def get_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to get_policy via a request object, either of type GetPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_policy(name: nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to get_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetPolicyRequest.new

# Call the get_policy method.
result = client.get_policy request

# The returned object is of type Google::Cloud::DesignCenter::V1::Policy.
p result

#get_share

def get_share(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Share
def get_share(name: nil) -> ::Google::Cloud::DesignCenter::V1::Share

Get catalog share object for the space.

Overloads 
def get_share(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Share
Pass arguments to get_share via a request object, either of type GetShareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetShareRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_share(name: nil) -> ::Google::Cloud::DesignCenter::V1::Share
Pass arguments to get_share via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetShareRequest.new

# Call the get_share method.
result = client.get_share request

# The returned object is of type Google::Cloud::DesignCenter::V1::Share.
p result

#get_shared_template

def get_shared_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplate
def get_shared_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplate

Gets details about a shared template.

Overloads 
def get_shared_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplate
Pass arguments to get_shared_template via a request object, either of type GetSharedTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetSharedTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_shared_template(name: nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplate
Pass arguments to get_shared_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The shared template name. Format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetSharedTemplateRequest.new

# Call the get_shared_template method.
result = client.get_shared_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::SharedTemplate.
p result

#get_shared_template_revision

def get_shared_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplateRevision
def get_shared_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplateRevision

Gets details about a shared template revision.

Overloads 
def get_shared_template_revision(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplateRevision
Pass arguments to get_shared_template_revision via a request object, either of type GetSharedTemplateRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetSharedTemplateRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_shared_template_revision(name: nil) -> ::Google::Cloud::DesignCenter::V1::SharedTemplateRevision
Pass arguments to get_shared_template_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The shared template revision name, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate/revisions/$revision
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetSharedTemplateRevisionRequest.new

# Call the get_shared_template_revision method.
result = client.get_shared_template_revision request

# The returned object is of type Google::Cloud::DesignCenter::V1::SharedTemplateRevision.
p result

#get_space

def get_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
def get_space(name: nil) -> ::Google::Cloud::DesignCenter::V1::Space

Gets details about a space.

Overloads 
def get_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to get_space via a request object, either of type GetSpaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::GetSpaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_space(name: nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to get_space via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The space name.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::GetSpaceRequest.new

# Call the get_space method.
result = client.get_space request

# The returned object is of type Google::Cloud::DesignCenter::V1::Space.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#import_application_ia_c

def import_application_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationIaCResponse
def import_application_ia_c(gcs_uri: nil, iac_module: nil, name: nil, allow_partial_import: nil, validate_iac: nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationIaCResponse

Imports IaC for an application resource.

Overloads 
def import_application_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationIaCResponse
Pass arguments to import_application_ia_c via a request object, either of type ImportApplicationIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ImportApplicationIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def import_application_ia_c(gcs_uri: nil, iac_module: nil, name: nil, allow_partial_import: nil, validate_iac: nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationIaCResponse
Pass arguments to import_application_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • gcs_uri (::String) — Optional. The Cloud Storage URI of the terraform code.

    Note: The following parameters are mutually exclusive: gcs_uri, iac_module. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • iac_module (::Google::Cloud::DesignCenter::V1::IaCModule, ::Hash) — Optional. The IaC module to import.

    Note: The following parameters are mutually exclusive: iac_module, gcs_uri. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) — Required. The name of the application.
  • allow_partial_import (::Boolean) — Optional. If set to true, partially imports the valid edits in the IaC and ignores the invalid changes. Defaults to false, which means any edits which can't be imported must result in an error.
  • validate_iac (::Boolean) — Optional. If set to true, the IaC is validated against the golden terraform without importing. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ImportApplicationIaCRequest.new

# Call the import_application_ia_c method.
result = client.import_application_ia_c request

# The returned object is of type Google::Cloud::DesignCenter::V1::ImportApplicationIaCResponse.
p result

#import_application_template

def import_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
def import_application_template(application_template_revision_uri: nil, shared_template_revision_uri: nil, serialized_application_template: nil, application_template_system_revision: nil, name: nil, annotations: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate

Imports to an existing application template from a given shared template.

Overloads 
def import_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to import_application_template via a request object, either of type ImportApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def import_application_template(application_template_revision_uri: nil, shared_template_revision_uri: nil, serialized_application_template: nil, application_template_system_revision: nil, name: nil, annotations: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to import_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • application_template_revision_uri (::String) — Optional. The source URI for application template revision.

    Note: The following parameters are mutually exclusive: application_template_revision_uri, shared_template_revision_uri, serialized_application_template, application_template_system_revision. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • shared_template_revision_uri (::String) — Optional. The source URI for catalog template.

    Note: The following parameters are mutually exclusive: shared_template_revision_uri, application_template_revision_uri, serialized_application_template, application_template_system_revision. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • serialized_application_template (::Google::Cloud::DesignCenter::V1::SerializedApplicationTemplate, ::Hash) — Optional. The serialized application template to be imported.

    Note: The following parameters are mutually exclusive: serialized_application_template, application_template_revision_uri, shared_template_revision_uri, application_template_system_revision. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • application_template_system_revision (::String) — Optional. The system revision to be imported. Used when user tries to Restore (rev X) or perform Undo/Redo operations.

    Note: The following parameters are mutually exclusive: application_template_system_revision, application_template_revision_uri, shared_template_revision_uri, serialized_application_template. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) — Required. The name of the application template.
  • annotations (::Hash{::String => ::String}) — Optional. Annotations to be stored with the new system revision created as a result of this import. Sample annotations from agentic workflows might look like { "designcenter.googleapis.com/agent_id": "gemini-3-flash-v1", "designcenter.googleapis.com/llm_agent_summary": "Restored to revision Rev-100", "designcenter.googleapis.com/external_ref_id": "trace-uuid-88921-xyz", }
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ImportApplicationTemplateRequest.new

# Call the import_application_template method.
result = client.import_application_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplate.
p result

#import_application_template_ia_c

def import_application_template_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCResponse
def import_application_template_ia_c(gcs_uri: nil, iac_module: nil, developer_connect_source_config: nil, name: nil, allow_partial_import: nil, validate_iac: nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCResponse

Imports IaC for an application template.

Overloads 
def import_application_template_ia_c(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCResponse
Pass arguments to import_application_template_ia_c via a request object, either of type ImportApplicationTemplateIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def import_application_template_ia_c(gcs_uri: nil, iac_module: nil, developer_connect_source_config: nil, name: nil, allow_partial_import: nil, validate_iac: nil) -> ::Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCResponse
Pass arguments to import_application_template_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • gcs_uri (::String) — Optional. The Cloud Storage URI of the terraform code.

    Note: The following parameters are mutually exclusive: gcs_uri, iac_module, developer_connect_source_config. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • iac_module (::Google::Cloud::DesignCenter::V1::IaCModule, ::Hash) — Optional. The IaC module to import.

    Note: The following parameters are mutually exclusive: iac_module, gcs_uri, developer_connect_source_config. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • developer_connect_source_config (::Google::Cloud::DesignCenter::V1::DeveloperConnectSourceConfig, ::Hash) — Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect.

    Note: The following parameters are mutually exclusive: developer_connect_source_config, gcs_uri, iac_module. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) — Required. The name of the application template.
  • allow_partial_import (::Boolean) — Optional. If set to true, partially imports the valid edits in the IaC and ignores the invalid changes. Defaults to false, which means any edits which can't be imported must result in an error.
  • validate_iac (::Boolean) — Optional. If set to true, the IaC is validated against the golden terraform without importing. Defaults to false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCRequest.new

# Call the import_application_template_ia_c method.
result = client.import_application_template_ia_c request

# The returned object is of type Google::Cloud::DesignCenter::V1::ImportApplicationTemplateIaCResponse.
p result

#ingest_application_template_ia_c

def ingest_application_template_ia_c(request, options = nil) -> ::Gapic::Operation
def ingest_application_template_ia_c(gcs_uri: nil, iac_module: nil, devconnect_source_config: nil, git_source: nil, name: nil, validate_catalog_compatibility: nil, raw_terraform_import_enabled: nil) -> ::Gapic::Operation

Ingests IaC for an application template asynchronously.

Overloads 
def ingest_application_template_ia_c(request, options = nil) -> ::Gapic::Operation
Pass arguments to ingest_application_template_ia_c via a request object, either of type IngestApplicationTemplateIaCRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::IngestApplicationTemplateIaCRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def ingest_application_template_ia_c(gcs_uri: nil, iac_module: nil, devconnect_source_config: nil, git_source: nil, name: nil, validate_catalog_compatibility: nil, raw_terraform_import_enabled: nil) -> ::Gapic::Operation
Pass arguments to ingest_application_template_ia_c via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • gcs_uri (::String) — Optional. The Cloud Storage URI of the terraform code.

    Note: The following parameters are mutually exclusive: gcs_uri, iac_module, devconnect_source_config, git_source. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • iac_module (::Google::Cloud::DesignCenter::V1::IaCModule, ::Hash) — Optional. The IaC configuration to import.

    Note: The following parameters are mutually exclusive: iac_module, gcs_uri, devconnect_source_config, git_source. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • devconnect_source_config (::Google::Cloud::DesignCenter::V1::DeveloperConnectSourceConfig, ::Hash) — Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect.

    Note: The following parameters are mutually exclusive: devconnect_source_config, gcs_uri, iac_module, git_source. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • git_source (::Google::Cloud::DesignCenter::V1::GitSource, ::Hash) — Optional. The git source.

    Note: The following parameters are mutually exclusive: git_source, gcs_uri, iac_module, devconnect_source_config. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) — Required. The name of the application template.
  • validate_catalog_compatibility (::Boolean) — Optional. If set to true, validates if the imported IaC is compatible with the catalog.
  • raw_terraform_import_enabled (::Boolean) — Optional. If set to true, imports the IaC as raw terraform and does not attempt SAT conversion.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::IngestApplicationTemplateIaCRequest.new

# Call the ingest_application_template_ia_c method.
result = client.ingest_application_template_ia_c request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

def initialize() { |config| ... } -> Client

Create a new DesignCenter client object.

Yields
  • (config) — Configure the DesignCenter client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DesignCenter::V1::DesignCenter::Client.new do |config|
  config.timeout = 10.0
end

#list_application_template_revisions

def list_application_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision>
def list_application_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision>

Lists application template revisions in a given application template.

Overloads 
def list_application_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision>
Pass arguments to list_application_template_revisions via a request object, either of type ListApplicationTemplateRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListApplicationTemplateRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_application_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision>
Pass arguments to list_application_template_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent from which to list application template revisions.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which application template revisions to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListApplicationTemplateRevisionsRequest.new

# Call the list_application_template_revisions method.
result = client.list_application_template_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::ApplicationTemplateRevision.
  p item
end

#list_application_template_system_revisions

def list_application_template_system_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision>
def list_application_template_system_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision>

Lists application template system revisions in a given application template.

Overloads 
def list_application_template_system_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision>
Pass arguments to list_application_template_system_revisions via a request object, either of type ListApplicationTemplateSystemRevisionsRequest or an equivalent Hash.
Parameters 
def list_application_template_system_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision>
Pass arguments to list_application_template_system_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent Application Template from which to list the system revisions. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}
  • page_size (::Integer) — Optional. The maximum number of system revisions to return. The service may return fewer than this value. If unspecified, at most 50 system revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter expression that filters system revisions listed in the response. See https://google.aip.dev/160 for more information on the grammar.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListApplicationTemplateSystemRevisionsRequest.new

# Call the list_application_template_system_revisions method.
result = client.list_application_template_system_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::ApplicationTemplateSystemRevision.
  p item
end

#list_application_templates

def list_application_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplate>
def list_application_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplate>

Lists application templates in a given space.

Overloads 
def list_application_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplate>
Pass arguments to list_application_templates via a request object, either of type ListApplicationTemplatesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListApplicationTemplatesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_application_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::ApplicationTemplate>
Pass arguments to list_application_templates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which to list application templates.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which shared template revisions to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListApplicationTemplatesRequest.new

# Call the list_application_templates method.
result = client.list_application_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::ApplicationTemplate.
  p item
end

#list_applications

def list_applications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Application>
def list_applications(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Application>

Lists applications in a given space.

Overloads 
def list_applications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Application>
Pass arguments to list_applications via a request object, either of type ListApplicationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListApplicationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_applications(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Application>
Pass arguments to list_applications via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which to request a list of applications.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which applications to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListApplicationsRequest.new

# Call the list_applications method.
result = client.list_applications request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Application.
  p item
end

#list_catalog_template_revisions

def list_catalog_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision>
def list_catalog_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision>

Lists template revisions.

Overloads 
def list_catalog_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision>
Pass arguments to list_catalog_template_revisions via a request object, either of type ListCatalogTemplateRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListCatalogTemplateRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_catalog_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision>
Pass arguments to list_catalog_template_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which a list of catalog template revisions is requested.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which catalog template revisions to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListCatalogTemplateRevisionsRequest.new

# Call the list_catalog_template_revisions method.
result = client.list_catalog_template_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::CatalogTemplateRevision.
  p item
end

#list_catalog_templates

def list_catalog_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplate>
def list_catalog_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplate>

Lists catalog templates.

Overloads 
def list_catalog_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplate>
Pass arguments to list_catalog_templates via a request object, either of type ListCatalogTemplatesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListCatalogTemplatesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_catalog_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::CatalogTemplate>
Pass arguments to list_catalog_templates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses the catalog templates to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListCatalogTemplatesRequest.new

# Call the list_catalog_templates method.
result = client.list_catalog_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::CatalogTemplate.
  p item
end

#list_catalogs

def list_catalogs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Catalog>
def list_catalogs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Catalog>

Lists catalogs in a given space.

Overloads 
def list_catalogs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Catalog>
Pass arguments to list_catalogs via a request object, either of type ListCatalogsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListCatalogsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_catalogs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Catalog>
Pass arguments to list_catalogs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent space from which catalogs are listed. Format: projects/$project/locations/$location/spaces/$space
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which catalogs to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListCatalogsRequest.new

# Call the list_catalogs method.
result = client.list_catalogs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Catalog.
  p item
end

#list_components

def list_components(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Component>
def list_components(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Component>

Lists components in an application template.

Overloads 
def list_components(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Component>
Pass arguments to list_components via a request object, either of type ListComponentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListComponentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_components(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Component>
Pass arguments to list_components via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which the list of components is requested.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which components to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListComponentsRequest.new

# Call the list_components method.
result = client.list_components request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Component.
  p item
end

#list_connections

def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Connection>
def list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Connection>

Lists connections in an application template.

Overloads 
def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Connection>
Pass arguments to list_connections via a request object, either of type ListConnectionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListConnectionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Connection>
Pass arguments to list_connections via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which to request a list of connections.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which connections to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListConnectionsRequest.new

# Call the list_connections method.
result = client.list_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Connection.
  p item
end

#list_policies

def list_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Policy>
def list_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Policy>

Lists policies for an application template.

Overloads 
def list_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Policy>
Pass arguments to list_policies via a request object, either of type ListPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListPoliciesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Policy>
Pass arguments to list_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent application template from which policies are listed in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which policies to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListPoliciesRequest.new

# Call the list_policies method.
result = client.list_policies request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Policy.
  p item
end

#list_shared_template_revisions

def list_shared_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplateRevision>
def list_shared_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplateRevision>

Lists shared template revisions in a given space.

Overloads 
def list_shared_template_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplateRevision>
Pass arguments to list_shared_template_revisions via a request object, either of type ListSharedTemplateRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListSharedTemplateRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_shared_template_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplateRevision>
Pass arguments to list_shared_template_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which to list shared template revisions, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which shared template revisions to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListSharedTemplateRevisionsRequest.new

# Call the list_shared_template_revisions method.
result = client.list_shared_template_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::SharedTemplateRevision.
  p item
end

#list_shared_templates

def list_shared_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplate>
def list_shared_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplate>

Lists shared templates in a given space.

Overloads 
def list_shared_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplate>
Pass arguments to list_shared_templates via a request object, either of type ListSharedTemplatesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListSharedTemplatesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_shared_templates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::SharedTemplate>
Pass arguments to list_shared_templates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent space for which shared templates are listed in the following format: projects/$project/locations/$location/spaces/$space
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which shared templates to return.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListSharedTemplatesRequest.new

# Call the list_shared_templates method.
result = client.list_shared_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::SharedTemplate.
  p item
end

#list_shares

def list_shares(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Share>
def list_shares(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Share>

Lists catalog share objects for the space.

Overloads 
def list_shares(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Share>
Pass arguments to list_shares via a request object, either of type ListSharesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListSharesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_shares(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Share>
Pass arguments to list_shares via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource from which a list of shares is requested.
  • page_size (::Integer) — Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
  • page_token (::String) — Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • order_by (::String) — Optional. How the results should be sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListSharesRequest.new

# Call the list_shares method.
result = client.list_shares request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Share.
  p item
end

#list_spaces

def list_spaces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Space>
def list_spaces(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Space>

Lists spaces in a given project and location.

Overloads 
def list_spaces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Space>
Pass arguments to list_spaces via a request object, either of type ListSpacesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::ListSpacesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_spaces(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DesignCenter::V1::Space>
Pass arguments to list_spaces via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource, for which spaces are listed.
  • page_size (::Integer) — Optional. The maximum number of pages to return from this request. If unspecified, the value automatically reflects the number of results returned.
  • page_token (::String) — Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
  • filter (::String) — Optional. A filter that chooses which spaces to return.
  • order_by (::String) — Optional. How the results are sorted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::ListSpacesRequest.new

# Call the list_spaces method.
result = client.list_spaces request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DesignCenter::V1::Space.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::DesignCenter::V1::DesignCenter::Operations

Get the associated client for long-running operations.

Returns

#preview_application

def preview_application(request, options = nil) -> ::Gapic::Operation
def preview_application(name: nil, worker_pool: nil, service_account: nil) -> ::Gapic::Operation

Previews deployment of an application.

Overloads 
def preview_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to preview_application via a request object, either of type PreviewApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::PreviewApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def preview_application(name: nil, worker_pool: nil, service_account: nil) -> ::Gapic::Operation
Pass arguments to preview_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application
  • worker_pool (::String) — Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application.
  • service_account (::String) —

    Optional. The email address of the service account to use for this preview operation.

    • If provided, this service account will be used to execute the preview process, taking precedence over any service_account specified on the Application resource.
    • The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
    • If this field is omitted, the system will use the 'service_account' defined within the Application resource.
    • We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the preview will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::PreviewApplicationRequest.new

# Call the preview_application method.
result = client.preview_application request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#recommend_iam_roles

def recommend_iam_roles(request, options = nil) -> ::Gapic::Operation
def recommend_iam_roles(name: nil) -> ::Gapic::Operation

Gets 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.

Overloads 
def recommend_iam_roles(request, options = nil) -> ::Gapic::Operation
Pass arguments to recommend_iam_roles via a request object, either of type RecommendIAMRolesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::RecommendIAMRolesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def recommend_iam_roles(name: nil) -> ::Gapic::Operation
Pass arguments to recommend_iam_roles via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the application resource for which to recommend IAM roles. Format: projects/$project/locations/$location/spaces/$space/applications/$application
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::RecommendIAMRolesRequest.new

# Call the recommend_iam_roles method.
result = client.recommend_iam_roles request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#register_app_hub_application_resources

def register_app_hub_application_resources(request, options = nil) -> ::Gapic::Operation
def register_app_hub_application_resources(tfstate_content: nil, tfstate_signed_gcs_uri: nil, parent: nil, apphub_application: nil) -> ::Gapic::Operation

Register deployed resources from terraform state file with App Hub without needing a space.

Overloads 
def register_app_hub_application_resources(request, options = nil) -> ::Gapic::Operation
Pass arguments to register_app_hub_application_resources via a request object, either of type RegisterAppHubApplicationResourcesRequest or an equivalent Hash.
Parameters 
def register_app_hub_application_resources(tfstate_content: nil, tfstate_signed_gcs_uri: nil, parent: nil, apphub_application: nil) -> ::Gapic::Operation
Pass arguments to register_app_hub_application_resources via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • tfstate_content (::String) — Optional. The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead.

    Note: The following parameters are mutually exclusive: tfstate_content, tfstate_signed_gcs_uri. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • tfstate_signed_gcs_uri (::String) — Optional. A securely signed Cloud Storage URI pointing to the tfstate file. The URI must be signed to grant the service temporary read access to the state file. Application Design Center imposes a limit on the maximum size of the state file accessed via this URI.

    Note: The following parameters are mutually exclusive: tfstate_signed_gcs_uri, tfstate_content. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • parent (::String) — Required. The parent location. Format: projects/{project}/locations/{location}
  • apphub_application (::String) — Required. The name of the AppHub Application. Format: projects/{project}/locations/{location}/applications/{application}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::RegisterAppHubApplicationResourcesRequest.new

# Call the register_app_hub_application_resources method.
result = client.register_app_hub_application_resources request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#snapshot_application_template

def snapshot_application_template(request, options = nil) -> ::Gapic::Operation
def snapshot_application_template(name: nil) -> ::Gapic::Operation

Snapshots an application template to create a new revision asynchronously.

Overloads 
def snapshot_application_template(request, options = nil) -> ::Gapic::Operation
Pass arguments to snapshot_application_template via a request object, either of type SnapshotApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::SnapshotApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def snapshot_application_template(name: nil) -> ::Gapic::Operation
Pass arguments to snapshot_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the application template.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::SnapshotApplicationTemplateRequest.new

# Call the snapshot_application_template method.
result = client.snapshot_application_template request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#sync_share

def sync_share(request, options = nil) -> ::Gapic::Operation
def sync_share(name: nil) -> ::Gapic::Operation

Synchronizes a share and updates the destination workspace to reflect. reflect the most recent changes to the catalog.

Overloads 
def sync_share(request, options = nil) -> ::Gapic::Operation
Pass arguments to sync_share via a request object, either of type SyncShareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::SyncShareRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def sync_share(name: nil) -> ::Gapic::Operation
Pass arguments to sync_share via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::SyncShareRequest.new

# Call the sync_share method.
result = client.sync_share request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_application

def update_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
def update_application(update_mask: nil, application: nil) -> ::Google::Cloud::DesignCenter::V1::Application

Updates an application.

Overloads 
def update_application(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to update_application via a request object, either of type UpdateApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateApplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_application(update_mask: nil, application: nil) -> ::Google::Cloud::DesignCenter::V1::Application
Pass arguments to update_application via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateApplicationRequest.new

# Call the update_application method.
result = client.update_application request

# The returned object is of type Google::Cloud::DesignCenter::V1::Application.
p result

#update_application_template

def update_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
def update_application_template(update_mask: nil, application_template: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate

Updates an application template.

Overloads 
def update_application_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to update_application_template via a request object, either of type UpdateApplicationTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateApplicationTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_application_template(update_mask: nil, application_template: nil) -> ::Google::Cloud::DesignCenter::V1::ApplicationTemplate
Pass arguments to update_application_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
  • application_template (::Google::Cloud::DesignCenter::V1::ApplicationTemplate, ::Hash) — Required. The application template to update.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateApplicationTemplateRequest.new

# Call the update_application_template method.
result = client.update_application_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::ApplicationTemplate.
p result

#update_catalog

def update_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
def update_catalog(update_mask: nil, catalog: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog

Updates a catalog.

Overloads 
def update_catalog(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to update_catalog via a request object, either of type UpdateCatalogRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateCatalogRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_catalog(update_mask: nil, catalog: nil) -> ::Google::Cloud::DesignCenter::V1::Catalog
Pass arguments to update_catalog via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateCatalogRequest.new

# Call the update_catalog method.
result = client.update_catalog request

# The returned object is of type Google::Cloud::DesignCenter::V1::Catalog.
p result

#update_catalog_template

def update_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
def update_catalog_template(catalog_template: nil, update_mask: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate

Updates a catalog template resource.

Overloads 
def update_catalog_template(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to update_catalog_template via a request object, either of type UpdateCatalogTemplateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateCatalogTemplateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_catalog_template(catalog_template: nil, update_mask: nil) -> ::Google::Cloud::DesignCenter::V1::CatalogTemplate
Pass arguments to update_catalog_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • catalog_template (::Google::Cloud::DesignCenter::V1::CatalogTemplate, ::Hash) — Required. The catalog template to update. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateCatalogTemplateRequest.new

# Call the update_catalog_template method.
result = client.update_catalog_template request

# The returned object is of type Google::Cloud::DesignCenter::V1::CatalogTemplate.
p result

#update_component

def update_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
def update_component(update_mask: nil, component: nil) -> ::Google::Cloud::DesignCenter::V1::Component

Updates a component.

Overloads 
def update_component(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to update_component via a request object, either of type UpdateComponentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateComponentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_component(update_mask: nil, component: nil) -> ::Google::Cloud::DesignCenter::V1::Component
Pass arguments to update_component via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateComponentRequest.new

# Call the update_component method.
result = client.update_component request

# The returned object is of type Google::Cloud::DesignCenter::V1::Component.
p result

#update_connection

def update_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
def update_connection(update_mask: nil, connection: nil) -> ::Google::Cloud::DesignCenter::V1::Connection

Updates a connection.

Overloads 
def update_connection(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to update_connection via a request object, either of type UpdateConnectionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_connection(update_mask: nil, connection: nil) -> ::Google::Cloud::DesignCenter::V1::Connection
Pass arguments to update_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
  • connection (::Google::Cloud::DesignCenter::V1::Connection, ::Hash) — Required. The connection to update.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateConnectionRequest.new

# Call the update_connection method.
result = client.update_connection request

# The returned object is of type Google::Cloud::DesignCenter::V1::Connection.
p result

#update_policy

def update_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
def update_policy(update_mask: nil, policy: nil) -> ::Google::Cloud::DesignCenter::V1::Policy

Updates a policy.

Overloads 
def update_policy(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to update_policy via a request object, either of type UpdatePolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdatePolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_policy(update_mask: nil, policy: nil) -> ::Google::Cloud::DesignCenter::V1::Policy
Pass arguments to update_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
  • policy (::Google::Cloud::DesignCenter::V1::Policy, ::Hash) — Required. The policy to update.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdatePolicyRequest.new

# Call the update_policy method.
result = client.update_policy request

# The returned object is of type Google::Cloud::DesignCenter::V1::Policy.
p result

#update_space

def update_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
def update_space(update_mask: nil, space: nil) -> ::Google::Cloud::DesignCenter::V1::Space

Updates a space.

Overloads 
def update_space(request, options = nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to update_space via a request object, either of type UpdateSpaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DesignCenter::V1::UpdateSpaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_space(update_mask: nil, space: nil) -> ::Google::Cloud::DesignCenter::V1::Space
Pass arguments to update_space via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/design_center/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DesignCenter::V1::DesignCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DesignCenter::V1::UpdateSpaceRequest.new

# Call the update_space method.
result = client.update_space request

# The returned object is of type Google::Cloud::DesignCenter::V1::Space.
p result