Class: Google::Cloud::TelcoAutomation::V1::TelcoAutomation::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/telco_automation/v1/telco_automation/client.rb

Overview

Client for the TelcoAutomation service.

TelcoAutomation Service manages the control plane cluster a.k.a. Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#blueprint_path, #deployment_path, #edge_slm_path, #hydrated_deployment_path, #location_path, #orchestration_cluster_path, #public_blueprint_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new TelcoAutomation client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::TelcoAutomation::V1::TelcoAutomation::Client.new

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

Yields:

  • (config) —

    Configure the TelcoAutomation client.

Yield Parameters:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 129

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/telcoautomation/v1/telcoautomation_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @telco_automation_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::TelcoAutomation::V1::TelcoAutomation::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @telco_automation_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @telco_automation_stub.endpoint
    config.universe_domain = @telco_automation_stub.universe_domain
    config.logger = @telco_automation_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


207
208
209
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 207

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::TelcoAutomation::V1::TelcoAutomation::Operations (readonly)

Get the associated client for long-running operations.

Returns:



200
201
202
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 200

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the TelcoAutomation Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all TelcoAutomation clients
::Google::Cloud::TelcoAutomation::V1::TelcoAutomation::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "TelcoAutomation", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#apply_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment #apply_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

Applies the deployment's YAML files to the parent orchestration cluster.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Deployment.
p result

Overloads:

  • #apply_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to apply_deployment via a request object, either of type ApplyDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ApplyDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #apply_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to apply_deployment 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) (defaults to: nil) —

      Required. The name of the deployment to apply to orchestration cluster.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3020

def apply_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ApplyDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.apply_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.apply_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.apply_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :apply_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#apply_hydrated_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment #apply_hydrated_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

Applies a hydrated deployment to a workload cluster.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::HydratedDeployment.
p result

Overloads:

  • #apply_hydrated_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

    Pass arguments to apply_hydrated_deployment via a request object, either of type ApplyHydratedDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ApplyHydratedDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #apply_hydrated_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

    Pass arguments to apply_hydrated_deployment 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) (defaults to: nil) —

      Required. The name of the hydrated deployment to apply.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3550

def apply_hydrated_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ApplyHydratedDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.apply_hydrated_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.apply_hydrated_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.apply_hydrated_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :apply_hydrated_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#approve_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #approve_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Approves a blueprint and commits a new revision.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #approve_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to approve_blueprint via a request object, either of type ApproveBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ApproveBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #approve_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to approve_blueprint 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) (defaults to: nil) —

      Required. The name of the blueprint to approve. The blueprint must be in Proposed state. A new revision is committed on approval.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1540

def approve_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ApproveBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.approve_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.approve_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.approve_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :approve_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#compute_deployment_status(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::ComputeDeploymentStatusResponse #compute_deployment_status(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::ComputeDeploymentStatusResponse

Returns the requested deployment status.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::ComputeDeploymentStatusResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3105

def compute_deployment_status request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ComputeDeploymentStatusRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.compute_deployment_status.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.compute_deployment_status.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.compute_deployment_status.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :compute_deployment_status, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the TelcoAutomation 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



99
100
101
102
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

#create_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #create_blueprint(parent: nil, blueprint_id: nil, blueprint: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Creates a blueprint.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #create_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to create_blueprint via a request object, either of type CreateBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::CreateBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_blueprint(parent: nil, blueprint_id: nil, blueprint: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to create_blueprint 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) (defaults to: nil) —

      Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • blueprint_id (::String) (defaults to: nil) —

      Optional. The name of the blueprint.

    • blueprint (::Google::Cloud::TelcoAutomation::V1::Blueprint, ::Hash) (defaults to: nil) —

      Required. The Blueprint 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.



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1084

def create_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::CreateBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :create_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment #create_deployment(parent: nil, deployment_id: nil, deployment: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

Creates a deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Deployment.
p result

Overloads:

  • #create_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to create_deployment via a request object, either of type CreateDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::CreateDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_deployment(parent: nil, deployment_id: nil, deployment: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to create_deployment 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) (defaults to: nil) —

      Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • deployment_id (::String) (defaults to: nil) —

      Optional. The name of the deployment.

    • deployment (::Google::Cloud::TelcoAutomation::V1::Deployment, ::Hash) (defaults to: nil) —

      Required. The Deployment 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.



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2383

def create_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::CreateDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :create_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_edge_slm(request, options = nil) ⇒ ::Gapic::Operation #create_edge_slm(parent: nil, edge_slm_id: nil, edge_slm: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new EdgeSlm in a given project and location.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the create_edge_slm method.
result = client.create_edge_slm 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

Overloads:

  • #create_edge_slm(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_edge_slm via a request object, either of type CreateEdgeSlmRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::CreateEdgeSlmRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_edge_slm(parent: nil, edge_slm_id: nil, edge_slm: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_edge_slm 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) (defaults to: nil) —

      Required. Value for parent.

    • edge_slm_id (::String) (defaults to: nil) —

      Required. Id of the requesting object If auto-generating Id server-side, remove this field and edge_slm_id from the method_signature of Create RPC

    • edge_slm (::Google::Cloud::TelcoAutomation::V1::EdgeSlm, ::Hash) (defaults to: nil) —

      Required. The resource being created

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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.



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 883

def create_edge_slm request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::CreateEdgeSlmRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_edge_slm.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_edge_slm.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_edge_slm.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :create_edge_slm, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_orchestration_cluster(request, options = nil) ⇒ ::Gapic::Operation #create_orchestration_cluster(parent: nil, orchestration_cluster_id: nil, orchestration_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new OrchestrationCluster in a given project and location.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the create_orchestration_cluster method.
result = client.create_orchestration_cluster 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

Overloads:

  • #create_orchestration_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_orchestration_cluster via a request object, either of type CreateOrchestrationClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::CreateOrchestrationClusterRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_orchestration_cluster(parent: nil, orchestration_cluster_id: nil, orchestration_cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_orchestration_cluster 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) (defaults to: nil) —

      Required. Value for parent.

    • orchestration_cluster_id (::String) (defaults to: nil) —

      Required. Id of the requesting object If auto-generating Id server-side, remove this field and orchestration_cluster_id from the method_signature of Create RPC

    • orchestration_cluster (::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster, ::Hash) (defaults to: nil) —

      Required. The resource being created

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 476

def create_orchestration_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::CreateOrchestrationClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_orchestration_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_orchestration_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_orchestration_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :create_orchestration_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_blueprint(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_blueprint(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a blueprint and all its revisions.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

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

Overloads:

  • #delete_blueprint(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_blueprint via a request object, either of type DeleteBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::DeleteBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_blueprint(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_blueprint 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) (defaults to: nil) —

      Required. The name of blueprint to delete. Blueprint name should be in the format {blueprint_id}, if {blueprint_id}@{revision_id} is passed then the API throws invalid argument.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1352

def delete_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::DeleteBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :delete_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_edge_slm(request, options = nil) ⇒ ::Gapic::Operation #delete_edge_slm(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes a single EdgeSlm.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the delete_edge_slm method.
result = client.delete_edge_slm 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

Overloads:

  • #delete_edge_slm(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_edge_slm via a request object, either of type DeleteEdgeSlmRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::DeleteEdgeSlmRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_edge_slm(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_edge_slm 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) (defaults to: nil) —

      Required. Name of the resource

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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.



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 991

def delete_edge_slm request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::DeleteEdgeSlmRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_edge_slm.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_edge_slm.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_edge_slm.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :delete_edge_slm, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_orchestration_cluster(request, options = nil) ⇒ ::Gapic::Operation #delete_orchestration_cluster(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes a single OrchestrationCluster.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the delete_orchestration_cluster method.
result = client.delete_orchestration_cluster 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

Overloads:

  • #delete_orchestration_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_orchestration_cluster via a request object, either of type DeleteOrchestrationClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::DeleteOrchestrationClusterRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_orchestration_cluster(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_orchestration_cluster 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) (defaults to: nil) —

      Required. Name of the resource

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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.



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 584

def delete_orchestration_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::DeleteOrchestrationClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_orchestration_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_orchestration_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_orchestration_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :delete_orchestration_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#discard_blueprint_changes(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::DiscardBlueprintChangesResponse #discard_blueprint_changes(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::DiscardBlueprintChangesResponse

Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision. No changes take place if a blueprint does not have revisions.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::DiscardBlueprintChangesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2108

def discard_blueprint_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::DiscardBlueprintChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.discard_blueprint_changes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.discard_blueprint_changes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.discard_blueprint_changes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :discard_blueprint_changes, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#discard_deployment_changes(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::DiscardDeploymentChangesResponse #discard_deployment_changes(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::DiscardDeploymentChangesResponse

Discards the changes in a deployment and reverts the deployment to the last approved deployment revision. No changes take place if a deployment does not have revisions.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::DiscardDeploymentChangesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2935

def discard_deployment_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::DiscardDeploymentChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.discard_deployment_changes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.discard_deployment_changes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.discard_deployment_changes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :discard_deployment_changes, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #get_blueprint(name: nil, view: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Returns the requested blueprint.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #get_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to get_blueprint via a request object, either of type GetBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_blueprint(name: nil, view: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to get_blueprint 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) (defaults to: nil) —

      Required. The name of the blueprint. Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned.

    • view (::Google::Cloud::TelcoAutomation::V1::BlueprintView) (defaults to: nil) —

      Optional. Defines the type of view of the blueprint. When field is not present BLUEPRINT_VIEW_BASIC is considered as default.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1264

def get_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment #get_deployment(name: nil, view: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

Returns the requested deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Deployment.
p result

Overloads:

  • #get_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to get_deployment via a request object, either of type GetDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_deployment(name: nil, view: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to get_deployment 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) (defaults to: nil) —

      Required. The name of the deployment. Case 1: If the name provided in the request is {deployment_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {deployment}, then the current state of the deployment is returned.

    • view (::Google::Cloud::TelcoAutomation::V1::DeploymentView) (defaults to: nil) —

      Optional. Defines the type of view of the deployment. When field is not present VIEW_BASIC is considered as default.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2564

def get_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_edge_slm(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::EdgeSlm #get_edge_slm(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::EdgeSlm

Gets details of a single EdgeSlm.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::EdgeSlm.
p result

Overloads:

  • #get_edge_slm(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::EdgeSlm

    Pass arguments to get_edge_slm via a request object, either of type GetEdgeSlmRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetEdgeSlmRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_edge_slm(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::EdgeSlm

    Pass arguments to get_edge_slm 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) (defaults to: nil) —

      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.



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 771

def get_edge_slm request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetEdgeSlmRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_edge_slm.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_edge_slm.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_edge_slm.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_edge_slm, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_hydrated_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment #get_hydrated_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

Returns the requested hydrated deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::HydratedDeployment.
p result

Overloads:

  • #get_hydrated_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

    Pass arguments to get_hydrated_deployment via a request object, either of type GetHydratedDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetHydratedDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_hydrated_deployment(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

    Pass arguments to get_hydrated_deployment 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) (defaults to: nil) —

      Required. Name of the hydrated deployment.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3278

def get_hydrated_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetHydratedDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_hydrated_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_hydrated_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_hydrated_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_hydrated_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_orchestration_cluster(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster #get_orchestration_cluster(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster

Gets details of a single OrchestrationCluster.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::OrchestrationCluster.
p result

Overloads:

  • #get_orchestration_cluster(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster

    Pass arguments to get_orchestration_cluster via a request object, either of type GetOrchestrationClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetOrchestrationClusterRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_orchestration_cluster(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster

    Pass arguments to get_orchestration_cluster 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) (defaults to: nil) —

      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.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 364

def get_orchestration_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetOrchestrationClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_orchestration_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_orchestration_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_orchestration_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_orchestration_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_public_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::PublicBlueprint #get_public_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::PublicBlueprint

Returns the requested public blueprint.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::PublicBlueprint.
p result

Overloads:

  • #get_public_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::PublicBlueprint

    Pass arguments to get_public_blueprint via a request object, either of type GetPublicBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::GetPublicBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_public_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::PublicBlueprint

    Pass arguments to get_public_blueprint 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) (defaults to: nil) —

      Required. The name of the public blueprint.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2292

def get_public_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::GetPublicBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_public_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_public_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_public_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :get_public_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_blueprint_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint> #list_blueprint_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

List blueprint revisions of a given blueprint.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_blueprint_revisions method.
result = client.list_blueprint_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::TelcoAutomation::V1::Blueprint.
  p item
end

Overloads:

  • #list_blueprint_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to list_blueprint_revisions via a request object, either of type ListBlueprintRevisionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListBlueprintRevisionsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_blueprint_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to list_blueprint_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:

    • name (::String) (defaults to: nil) —

      Required. The name of the blueprint to list revisions for.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of revisions to return per page.

    • page_token (::String) (defaults to: nil) —

      The page token, received from a previous ListBlueprintRevisions call It can be provided to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1804

def list_blueprint_revisions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListBlueprintRevisionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_blueprint_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_blueprint_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_blueprint_revisions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_blueprint_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_blueprint_revisions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_blueprints(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint> #list_blueprints(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

List all blueprints.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_blueprints method.
result = client.list_blueprints 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::TelcoAutomation::V1::Blueprint.
  p item
end

Overloads:

  • #list_blueprints(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to list_blueprints via a request object, either of type ListBlueprintsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListBlueprintsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_blueprints(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to list_blueprints 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) (defaults to: nil) —

      Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • filter (::String) (defaults to: nil) —

      Optional. Filtering only supports equality on blueprint state. It should be in the form: "state = DRAFT". OR operator can be used to get response for multiple states. e.g. "state = DRAFT OR state = PROPOSED".

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of blueprints to return per page.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous ListBlueprints call. It can be provided to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1452

def list_blueprints request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListBlueprintsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_blueprints.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_blueprints.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_blueprints.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_blueprints, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_blueprints, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deployment_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment> #list_deployment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

List deployment revisions of a given deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_deployment_revisions method.
result = client.list_deployment_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::TelcoAutomation::V1::Deployment.
  p item
end

Overloads:

  • #list_deployment_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to list_deployment_revisions via a request object, either of type ListDeploymentRevisionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListDeploymentRevisionsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_deployment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to list_deployment_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:

    • name (::String) (defaults to: nil) —

      Required. The name of the deployment to list revisions for.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of revisions to return per page.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous ListDeploymentRevisions call Provide this to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2846

def list_deployment_revisions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListDeploymentRevisionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_deployment_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_deployment_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_deployment_revisions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_deployment_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_deployment_revisions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment> #list_deployments(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

List all deployments.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_deployments method.
result = client.list_deployments 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::TelcoAutomation::V1::Deployment.
  p item
end

Overloads:

  • #list_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to list_deployments via a request object, either of type ListDeploymentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListDeploymentsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_deployments(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to list_deployments 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) (defaults to: nil) —

      Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • filter (::String) (defaults to: nil) —

      Optional. Filtering only supports equality on deployment state. It should be in the form: "state = DRAFT". OR operator can be used to get response for multiple states. e.g. "state = DRAFT OR state = APPLIED".

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of deployments to return per page.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous ListDeployments call. It can be provided to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2750

def list_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_deployments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_deployments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_deployments, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_edge_slms(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::EdgeSlm> #list_edge_slms(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::EdgeSlm>

Lists EdgeSlms in a given project and location.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_edge_slms method.
result = client.list_edge_slms 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::TelcoAutomation::V1::EdgeSlm.
  p item
end

Overloads:

  • #list_edge_slms(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::EdgeSlm>

    Pass arguments to list_edge_slms via a request object, either of type ListEdgeSlmsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListEdgeSlmsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_edge_slms(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::EdgeSlm>

    Pass arguments to list_edge_slms 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) (defaults to: nil) —

      Required. Parent value for ListEdgeSlmsRequest

    • page_size (::Integer) (defaults to: nil) —

      Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Filtering results

    • order_by (::String) (defaults to: nil) —

      Hint for how to order the results

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 684

def list_edge_slms request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListEdgeSlmsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_edge_slms.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_edge_slms.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_edge_slms.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_edge_slms, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_edge_slms, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_hydrated_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::HydratedDeployment> #list_hydrated_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::HydratedDeployment>

List all hydrated deployments present under a deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_hydrated_deployments method.
result = client.list_hydrated_deployments 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::TelcoAutomation::V1::HydratedDeployment.
  p item
end

Overloads:

  • #list_hydrated_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::HydratedDeployment>

    Pass arguments to list_hydrated_deployments via a request object, either of type ListHydratedDeploymentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListHydratedDeploymentsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_hydrated_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::HydratedDeployment>

    Pass arguments to list_hydrated_deployments 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) (defaults to: nil) —

      Required. The deployment managing the hydrated deployments.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of hydrated deployments to return. The service may return fewer than this value. If unspecified, at most 50 hydrated deployments will be returned. The maximum value is 1000. Values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous ListHydratedDeployments call. Provide this to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3375

def list_hydrated_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListHydratedDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_hydrated_deployments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_hydrated_deployments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_hydrated_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_hydrated_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_hydrated_deployments, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_orchestration_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster> #list_orchestration_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster>

Lists OrchestrationClusters in a given project and location.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_orchestration_clusters method.
result = client.list_orchestration_clusters 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::TelcoAutomation::V1::OrchestrationCluster.
  p item
end

Overloads:

  • #list_orchestration_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster>

    Pass arguments to list_orchestration_clusters via a request object, either of type ListOrchestrationClustersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListOrchestrationClustersRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_orchestration_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::OrchestrationCluster>

    Pass arguments to list_orchestration_clusters 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) (defaults to: nil) —

      Required. Parent value for ListOrchestrationClustersRequest

    • page_size (::Integer) (defaults to: nil) —

      Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Filtering results.

    • order_by (::String) (defaults to: nil) —

      Hint for how to order the results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 277

def list_orchestration_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListOrchestrationClustersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_orchestration_clusters.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_orchestration_clusters.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_orchestration_clusters.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_orchestration_clusters, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_orchestration_clusters, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_public_blueprints(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::PublicBlueprint> #list_public_blueprints(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::PublicBlueprint>

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the list_public_blueprints method.
result = client.list_public_blueprints 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::TelcoAutomation::V1::PublicBlueprint.
  p item
end

Overloads:

  • #list_public_blueprints(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::PublicBlueprint>

    Pass arguments to list_public_blueprints via a request object, either of type ListPublicBlueprintsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ListPublicBlueprintsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_public_blueprints(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::PublicBlueprint>

    Pass arguments to list_public_blueprints 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) (defaults to: nil) —

      Required. Parent value of public blueprint. Format should be - "projects/{project_id}/locations/{location_name}".

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A token identifying a page of results the server should return.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2205

def list_public_blueprints request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ListPublicBlueprintsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_public_blueprints.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_public_blueprints.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_public_blueprints.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :list_public_blueprints, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :list_public_blueprints, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


214
215
216
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 214

def logger
  @telco_automation_stub.logger
end

#propose_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #propose_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Proposes a blueprint for approval of changes.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #propose_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to propose_blueprint via a request object, either of type ProposeBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::ProposeBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #propose_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to propose_blueprint 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) (defaults to: nil) —

      Required. The name of the blueprint being proposed.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1625

def propose_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::ProposeBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.propose_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.propose_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.propose_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :propose_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reject_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #reject_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Rejects a blueprint revision proposal and flips it back to Draft state.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #reject_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to reject_blueprint via a request object, either of type RejectBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::RejectBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reject_blueprint(name: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to reject_blueprint 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) (defaults to: nil) —

      Required. The name of the blueprint being rejected.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1710

def reject_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::RejectBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reject_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reject_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reject_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :reject_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty #remove_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

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

Overloads:

  • #remove_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_deployment via a request object, either of type RemoveDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::RemoveDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #remove_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_deployment 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) (defaults to: nil) —

      Required. The name of deployment to initiate delete.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2650

def remove_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::RemoveDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.remove_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.remove_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.remove_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :remove_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rollback_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment #rollback_deployment(name: nil, revision_id: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

Rollback the active deployment to the given past approved deployment revision.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Deployment.
p result

Overloads:

  • #rollback_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to rollback_deployment via a request object, either of type RollbackDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::RollbackDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #rollback_deployment(name: nil, revision_id: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

    Pass arguments to rollback_deployment 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) (defaults to: nil) —

      Required. Name of the deployment.

    • revision_id (::String) (defaults to: nil) —

      Required. The revision id of deployment to roll back to.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3193

def rollback_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::RollbackDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.rollback_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.rollback_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.rollback_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :rollback_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_blueprint_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint> #search_blueprint_revisions(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

Searches across blueprint revisions.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the search_blueprint_revisions method.
result = client.search_blueprint_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::TelcoAutomation::V1::Blueprint.
  p item
end

Overloads:

  • #search_blueprint_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to search_blueprint_revisions via a request object, either of type SearchBlueprintRevisionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::SearchBlueprintRevisionsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_blueprint_revisions(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Blueprint>

    Pass arguments to search_blueprint_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) (defaults to: nil) —

      Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • query (::String) (defaults to: nil) —

      Required. Supported queries:

      1. "" : Lists all revisions across all blueprints.
      2. "latest=true" : Lists latest revisions across all blueprints.
      3. "name={name}" : Lists all revisions of blueprint with name {name}.
      4. "name={name} latest=true": Lists latest revision of blueprint with name {name}
    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of blueprints revisions to return per page. max page size = 100, default page size = 20.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous search call. It can be provided to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1911

def search_blueprint_revisions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::SearchBlueprintRevisionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_blueprint_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_blueprint_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_blueprint_revisions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :search_blueprint_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :search_blueprint_revisions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_deployment_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment> #search_deployment_revisions(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

Searches across deployment revisions.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

# Call the search_deployment_revisions method.
result = client.search_deployment_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::TelcoAutomation::V1::Deployment.
  p item
end

Overloads:

  • #search_deployment_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to search_deployment_revisions via a request object, either of type SearchDeploymentRevisionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::SearchDeploymentRevisionsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_deployment_revisions(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::TelcoAutomation::V1::Deployment>

    Pass arguments to search_deployment_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) (defaults to: nil) —

      Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".

    • query (::String) (defaults to: nil) —

      Required. Supported queries:

      1. "" : Lists all revisions across all deployments.
      2. "latest=true" : Lists latest revisions across all deployments.
      3. "name={name}" : Lists all revisions of deployment with name {name}.
      4. "name={name} latest=true": Lists latest revision of deployment with name {name}
    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of deployment revisions to return per page. max page size = 100, default page size = 20.

    • page_token (::String) (defaults to: nil) —

      Optional. The page token, received from a previous search call. It can be provided to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2019

def search_deployment_revisions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::SearchDeploymentRevisionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_deployment_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_deployment_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_deployment_revisions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :search_deployment_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @telco_automation_stub, :search_deployment_revisions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 109

def universe_domain
  @telco_automation_stub.universe_domain
end

#update_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint #update_blueprint(blueprint: nil, update_mask: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

Updates a blueprint.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Blueprint.
p result

Overloads:

  • #update_blueprint(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to update_blueprint via a request object, either of type UpdateBlueprintRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TelcoAutomation::V1::UpdateBlueprintRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_blueprint(blueprint: nil, update_mask: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Blueprint

    Pass arguments to update_blueprint 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.



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 1172

def update_blueprint request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::UpdateBlueprintRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_blueprint.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.blueprint&.name
    header_params["blueprint.name"] = request.blueprint.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_blueprint.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_blueprint.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :update_blueprint, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment #update_deployment(deployment: nil, update_mask: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::Deployment

Updates a deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::Deployment.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 2471

def update_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::UpdateDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.deployment&.name
    header_params["deployment.name"] = request.deployment.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :update_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_hydrated_deployment(request, options = nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment #update_hydrated_deployment(hydrated_deployment: nil, update_mask: nil) ⇒ ::Google::Cloud::TelcoAutomation::V1::HydratedDeployment

Updates a hydrated deployment.

Examples:

Basic example

require "google/cloud/telco_automation/v1"

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

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

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

# The returned object is of type Google::Cloud::TelcoAutomation::V1::HydratedDeployment.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
 
# File 'lib/google/cloud/telco_automation/v1/telco_automation/client.rb', line 3465

def update_hydrated_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TelcoAutomation::V1::UpdateHydratedDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_hydrated_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TelcoAutomation::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.hydrated_deployment&.name
    header_params["hydrated_deployment.name"] = request.hydrated_deployment.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_hydrated_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_hydrated_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @telco_automation_stub.call_rpc :update_hydrated_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end