Class: Google::Cloud::ApigeeRegistry::V1::Registry::Rest::Client

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

Overview

REST client for the Registry service.

The Registry service allows teams to manage descriptions of APIs.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#api_deployment_path, #api_path, #api_spec_path, #api_version_path, #artifact_path, #location_path

Constructor Details

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

Create a new Registry REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the Registry client.

Yield Parameters:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 297

def initialize
  # 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

  @registry_stub = ::Google::Cloud::ApigeeRegistry::V1::Registry::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @registry_stub.logger(stub: true)&.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::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @registry_stub.endpoint
    config.universe_domain = @registry_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @registry_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @registry_stub.endpoint
    config.universe_domain = @registry_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @registry_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

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

Returns:

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


369
370
371
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 369

def iam_policy_client
  @iam_policy_client
end

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

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

Returns:

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


362
363
364
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 362

def location_client
  @location_client
end

Class Method Details

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

Configure the Registry Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ApigeeRegistry", "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.rpcs.list_apis.timeout = 60.0
    default_config.rpcs.list_apis.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_api.timeout = 60.0
    default_config.rpcs.get_api.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.create_api.timeout = 60.0
    default_config.rpcs.create_api.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.update_api.timeout = 60.0
    default_config.rpcs.update_api.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.delete_api.timeout = 60.0
    default_config.rpcs.delete_api.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_api_versions.timeout = 60.0
    default_config.rpcs.list_api_versions.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_api_version.timeout = 60.0
    default_config.rpcs.get_api_version.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.create_api_version.timeout = 60.0
    default_config.rpcs.create_api_version.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.update_api_version.timeout = 60.0
    default_config.rpcs.update_api_version.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.delete_api_version.timeout = 60.0
    default_config.rpcs.delete_api_version.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_api_specs.timeout = 60.0
    default_config.rpcs.list_api_specs.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_api_spec.timeout = 60.0
    default_config.rpcs.get_api_spec.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_api_spec_contents.timeout = 60.0
    default_config.rpcs.get_api_spec_contents.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.create_api_spec.timeout = 60.0
    default_config.rpcs.create_api_spec.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.update_api_spec.timeout = 60.0
    default_config.rpcs.update_api_spec.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.delete_api_spec.timeout = 60.0
    default_config.rpcs.delete_api_spec.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.tag_api_spec_revision.timeout = 60.0
    default_config.rpcs.tag_api_spec_revision.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_api_spec_revisions.timeout = 60.0
    default_config.rpcs.list_api_spec_revisions.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.rollback_api_spec.timeout = 60.0

    default_config.rpcs.delete_api_spec_revision.timeout = 60.0
    default_config.rpcs.delete_api_spec_revision.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_api_deployments.timeout = 60.0
    default_config.rpcs.list_api_deployments.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_api_deployment.timeout = 60.0
    default_config.rpcs.get_api_deployment.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.create_api_deployment.timeout = 60.0
    default_config.rpcs.create_api_deployment.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.update_api_deployment.timeout = 60.0
    default_config.rpcs.update_api_deployment.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.delete_api_deployment.timeout = 60.0
    default_config.rpcs.delete_api_deployment.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.tag_api_deployment_revision.timeout = 60.0
    default_config.rpcs.tag_api_deployment_revision.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_api_deployment_revisions.timeout = 60.0
    default_config.rpcs.list_api_deployment_revisions.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.rollback_api_deployment.timeout = 60.0

    default_config.rpcs.delete_api_deployment_revision.timeout = 60.0
    default_config.rpcs.delete_api_deployment_revision.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.list_artifacts.timeout = 60.0
    default_config.rpcs.list_artifacts.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_artifact.timeout = 60.0
    default_config.rpcs.get_artifact.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.get_artifact_contents.timeout = 60.0
    default_config.rpcs.get_artifact_contents.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.create_artifact.timeout = 60.0
    default_config.rpcs.create_artifact.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.replace_artifact.timeout = 60.0
    default_config.rpcs.replace_artifact.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config.rpcs.delete_artifact.timeout = 60.0
    default_config.rpcs.delete_artifact.retry_policy = {
      initial_delay: 0.2, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the Registry 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:



267
268
269
270
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 267

def configure
  yield @config if block_given?
  @config
end

#create_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api #create_api(parent: nil, api: nil, api_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

Creates a specified API.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Api.
p result

Overloads:

  • #create_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiRequest, ::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_api(parent: nil, api: nil, api_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

    Pass arguments to create_api 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 parent, which owns this collection of APIs. Format: projects/*/locations/*

    • api (::Google::Cloud::ApigeeRegistry::V1::Api, ::Hash) (defaults to: nil) —

      Required. The API to create.

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

      Required. The ID to use for the API, which will become the final component of the API's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

      Following AIP-162, IDs must not have the form of a UUID.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 614

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::CreateApiRequest

  # 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
  call_metadata = @config.rpcs.create_api.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_api.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_api.retry_policy

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

  @registry_stub.create_api request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #create_api_deployment(parent: nil, api_deployment: nil, api_deployment_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Creates a specified deployment.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #create_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiDeploymentRequest, ::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_api_deployment(parent: nil, api_deployment: nil, api_deployment_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to create_api_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 parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*

    • api_deployment (::Google::Cloud::ApigeeRegistry::V1::ApiDeployment, ::Hash) (defaults to: nil) —

      Required. The deployment to create.

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

      Required. The ID to use for the deployment, which will become the final component of the deployment's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

      Following AIP-162, IDs must not have the form of a UUID.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2350

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::CreateApiDeploymentRequest

  # 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
  call_metadata = @config.rpcs.create_api_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_api_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_api_deployment.retry_policy

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

  @registry_stub.create_api_deployment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #create_api_spec(parent: nil, api_spec: nil, api_spec_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Creates a specified spec.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #create_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiSpecRequest, ::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_api_spec(parent: nil, api_spec: nil, api_spec_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to create_api_spec 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 parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

    • api_spec (::Google::Cloud::ApigeeRegistry::V1::ApiSpec, ::Hash) (defaults to: nil) —

      Required. The spec to create.

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

      Required. The ID to use for the spec, which will become the final component of the spec's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

      Following AIP-162, IDs must not have the form of a UUID.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1574

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::CreateApiSpecRequest

  # 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
  call_metadata = @config.rpcs.create_api_spec.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_api_spec.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_api_spec.retry_policy

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

  @registry_stub.create_api_spec request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion #create_api_version(parent: nil, api_version: nil, api_version_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Creates a specified version.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiVersion.
p result

Overloads:

  • #create_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::CreateApiVersionRequest, ::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_api_version(parent: nil, api_version: nil, api_version_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

    Pass arguments to create_api_version 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 parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*

    • api_version (::Google::Cloud::ApigeeRegistry::V1::ApiVersion, ::Hash) (defaults to: nil) —

      Required. The version to create.

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

      Required. The ID to use for the version, which will become the final component of the version's resource name.

      This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.

      Following AIP-162, IDs must not have the form of a UUID.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1053

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::CreateApiVersionRequest

  # 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
  call_metadata = @config.rpcs.create_api_version.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_api_version.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_api_version.retry_policy

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

  @registry_stub.create_api_version request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_artifact(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact #create_artifact(parent: nil, artifact: nil, artifact_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

Creates a specified artifact.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Artifact.
p result

Overloads:

  • #create_artifact(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::CreateArtifactRequest, ::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_artifact(parent: nil, artifact: nil, artifact_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

    Pass arguments to create_artifact 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 parent, which owns this collection of artifacts. Format: {parent}

    • artifact (::Google::Cloud::ApigeeRegistry::V1::Artifact, ::Hash) (defaults to: nil) —

      Required. The artifact to create.

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

      Required. The ID to use for the artifact, which will become the final component of the artifact's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

      Following AIP-162, IDs must not have the form of a UUID.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 3209

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::CreateArtifactRequest

  # 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
  call_metadata = @config.rpcs.create_artifact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_artifact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_artifact.retry_policy

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

  @registry_stub.create_artifact request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Removes a specified API and all of the resources that it owns.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiRequest, ::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_api(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_api 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 API to delete. Format: projects/*/locations/*/apis/*

    • force (::Boolean) (defaults to: nil) —

      If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
811
812
813
814
815
816
817
818
819
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 786

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiRequest

  # 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
  call_metadata = @config.rpcs.delete_api.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api.retry_policy

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

  @registry_stub.delete_api request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRequest, ::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_api_deployment(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_api_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 delete. Format: projects/*/locations/*/apis/*/deployments/*

    • force (::Boolean) (defaults to: nil) —

      If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2522

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRequest

  # 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
  call_metadata = @config.rpcs.delete_api_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api_deployment.retry_policy

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

  @registry_stub.delete_api_deployment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_api_deployment_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #delete_api_deployment_revision(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Deletes a revision of a deployment.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #delete_api_deployment_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRevisionRequest, ::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_api_deployment_revision(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to delete_api_deployment_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The name of the deployment revision to be deleted, with a revision ID explicitly included.

      Example: projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2888
2889
2890
2891
2892
2893
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2860

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRevisionRequest

  # 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
  call_metadata = @config.rpcs.delete_api_deployment_revision.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api_deployment_revision.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api_deployment_revision.retry_policy

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

  @registry_stub.delete_api_deployment_revision request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRequest, ::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_api_spec(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_api_spec 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 spec to delete. Format: projects/*/locations/*/apis/*/versions/*/specs/*

    • force (::Boolean) (defaults to: nil) —

      If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1746

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRequest

  # 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
  call_metadata = @config.rpcs.delete_api_spec.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api_spec.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api_spec.retry_policy

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

  @registry_stub.delete_api_spec request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_api_spec_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #delete_api_spec_revision(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Deletes a revision of a spec.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #delete_api_spec_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRevisionRequest, ::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_api_spec_revision(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to delete_api_spec_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The name of the spec revision to be deleted, with a revision ID explicitly included.

      Example: projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2083

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRevisionRequest

  # 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
  call_metadata = @config.rpcs.delete_api_spec_revision.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api_spec_revision.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api_spec_revision.retry_policy

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

  @registry_stub.delete_api_spec_revision request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Removes a specified version and all of the resources that it owns.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteApiVersionRequest, ::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_api_version(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_api_version 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 version to delete. Format: projects/*/locations/*/apis/*/versions/*

    • force (::Boolean) (defaults to: nil) —

      If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1225

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteApiVersionRequest

  # 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
  call_metadata = @config.rpcs.delete_api_version.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_api_version.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_api_version.retry_policy

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

  @registry_stub.delete_api_version request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Removes a specified artifact.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::DeleteArtifactRequest, ::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_artifact(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_artifact 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 artifact to delete. Format: {parent}/artifacts/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3369
3370
3371
3372
3373
3374
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
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 3369

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::DeleteArtifactRequest

  # 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
  call_metadata = @config.rpcs.delete_artifact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_artifact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_artifact.retry_policy

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

  @registry_stub.delete_artifact request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api #get_api(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

Returns a specified API.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Api.
p result

Overloads:

  • #get_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetApiRequest, ::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_api(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

    Pass arguments to get_api 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 API to retrieve. Format: projects/*/locations/*/apis/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 525

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetApiRequest

  # 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
  call_metadata = @config.rpcs.get_api.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_api.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_api.retry_policy

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

  @registry_stub.get_api request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #get_api_deployment(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Returns a specified deployment.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #get_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetApiDeploymentRequest, ::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_api_deployment(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to get_api_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 retrieve. Format: projects/*/locations/*/apis/*/deployments/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2261

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetApiDeploymentRequest

  # 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
  call_metadata = @config.rpcs.get_api_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_api_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_api_deployment.retry_policy

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

  @registry_stub.get_api_deployment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #get_api_spec(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Returns a specified spec.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #get_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetApiSpecRequest, ::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_api_spec(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to get_api_spec 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 spec to retrieve. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1403

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetApiSpecRequest

  # 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
  call_metadata = @config.rpcs.get_api_spec.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_api_spec.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_api_spec.retry_policy

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

  @registry_stub.get_api_spec request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_api_spec_contents(request, options = nil) ⇒ ::Google::Api::HttpBody #get_api_spec_contents(name: nil) ⇒ ::Google::Api::HttpBody

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Api::HttpBody.
p result

Overloads:

  • #get_api_spec_contents(request, options = nil) ⇒ ::Google::Api::HttpBody

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetApiSpecContentsRequest, ::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_api_spec_contents(name: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to get_api_spec_contents 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 spec whose contents should be retrieved. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1485

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetApiSpecContentsRequest

  # 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
  call_metadata = @config.rpcs.get_api_spec_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_api_spec_contents.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_api_spec_contents.retry_policy

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

  @registry_stub.get_api_spec_contents request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion #get_api_version(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Returns a specified version.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiVersion.
p result

Overloads:

  • #get_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetApiVersionRequest, ::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_api_version(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

    Pass arguments to get_api_version 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 version to retrieve. Format: projects/*/locations/*/apis/*/versions/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 964

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetApiVersionRequest

  # 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
  call_metadata = @config.rpcs.get_api_version.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_api_version.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_api_version.retry_policy

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

  @registry_stub.get_api_version request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_artifact(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact #get_artifact(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

Returns a specified artifact.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Artifact.
p result

Overloads:

  • #get_artifact(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetArtifactRequest, ::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_artifact(name: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

    Pass arguments to get_artifact 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 artifact to retrieve. Format: {parent}/artifacts/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 3038

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetArtifactRequest

  # 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
  call_metadata = @config.rpcs.get_artifact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_artifact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_artifact.retry_policy

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

  @registry_stub.get_artifact request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_artifact_contents(request, options = nil) ⇒ ::Google::Api::HttpBody #get_artifact_contents(name: nil) ⇒ ::Google::Api::HttpBody

Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Api::HttpBody.
p result

Overloads:

  • #get_artifact_contents(request, options = nil) ⇒ ::Google::Api::HttpBody

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::GetArtifactContentsRequest, ::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_artifact_contents(name: nil) ⇒ ::Google::Api::HttpBody

    Pass arguments to get_artifact_contents 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 artifact whose contents should be retrieved. Format: {parent}/artifacts/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
3145
3146
3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 3120

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::GetArtifactContentsRequest

  # 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
  call_metadata = @config.rpcs.get_artifact_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_artifact_contents.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_artifact_contents.retry_policy

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

  @registry_stub.get_artifact_contents request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_api_deployment_revisions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment> #list_api_deployment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_api_deployment_revisions method.
result = client.list_api_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::ApigeeRegistry::V1::ApiDeployment.
  p item
end

Overloads:

  • #list_api_deployment_revisions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentRevisionsRequest, ::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_api_deployment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

    Pass arguments to list_api_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) —

      The maximum number of revisions to return per page.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2692

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentRevisionsRequest

  # 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
  call_metadata = @config.rpcs.list_api_deployment_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_api_deployment_revisions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_api_deployment_revisions.retry_policy

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

  @registry_stub.list_api_deployment_revisions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_api_deployment_revisions, "api_deployments", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_api_deployments(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment> #list_api_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

Returns matching deployments.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_api_deployments method.
result = client.list_api_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::ApigeeRegistry::V1::ApiDeployment.
  p item
end

Overloads:

  • #list_api_deployments(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentsRequest, ::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_api_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>

    Pass arguments to list_api_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 parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*

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

      The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListApiDeployments call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListApiDeployments must match the call that provided the page token.

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

      An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2180

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentsRequest

  # 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
  call_metadata = @config.rpcs.list_api_deployments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_api_deployments.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_api_deployments.retry_policy

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

  @registry_stub.list_api_deployments request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_api_deployments, "api_deployments", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_api_spec_revisions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec> #list_api_spec_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_api_spec_revisions method.
result = client.list_api_spec_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::ApigeeRegistry::V1::ApiSpec.
  p item
end

Overloads:

  • #list_api_spec_revisions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApiSpecRevisionsRequest, ::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_api_spec_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

    Pass arguments to list_api_spec_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 spec 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 ListApiSpecRevisions call. Provide this to retrieve the subsequent page.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1915

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecRevisionsRequest

  # 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
  call_metadata = @config.rpcs.list_api_spec_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_api_spec_revisions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_api_spec_revisions.retry_policy

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

  @registry_stub.list_api_spec_revisions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_api_spec_revisions, "api_specs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_api_specs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec> #list_api_specs(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

Returns matching specs.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_api_specs method.
result = client.list_api_specs 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::ApigeeRegistry::V1::ApiSpec.
  p item
end

Overloads:

  • #list_api_specs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApiSpecsRequest, ::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_api_specs(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>

    Pass arguments to list_api_specs 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 parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

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

      The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListApiSpecs call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListApiSpecs must match the call that provided the page token.

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

      An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1322

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecsRequest

  # 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
  call_metadata = @config.rpcs.list_api_specs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_api_specs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_api_specs.retry_policy

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

  @registry_stub.list_api_specs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_api_specs, "api_specs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_api_versions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion> #list_api_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>

Returns matching versions.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_api_versions method.
result = client.list_api_versions 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::ApigeeRegistry::V1::ApiVersion.
  p item
end

Overloads:

  • #list_api_versions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApiVersionsRequest, ::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_api_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>

    Pass arguments to list_api_versions 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 parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*

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

      The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListApiVersions call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListApiVersions must match the call that provided the page token.

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

      An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call 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
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 883

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApiVersionsRequest

  # 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
  call_metadata = @config.rpcs.list_api_versions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_api_versions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_api_versions.retry_policy

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

  @registry_stub.list_api_versions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_api_versions, "api_versions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_apis(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api> #list_apis(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>

Returns matching APIs.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_apis method.
result = client.list_apis 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::ApigeeRegistry::V1::Api.
  p item
end

Overloads:

  • #list_apis(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListApisRequest, ::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_apis(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Api>

    Pass arguments to list_apis 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 parent, which owns this collection of APIs. Format: projects/*/locations/*

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

      The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListApis call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListApis must match the call that provided the page token.

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

      An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 444

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListApisRequest

  # 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
  call_metadata = @config.rpcs.list_apis.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_apis.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_apis.retry_policy

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

  @registry_stub.list_apis request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_apis, "apis", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_artifacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact> #list_artifacts(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>

Returns matching artifacts.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

# Call the list_artifacts method.
result = client.list_artifacts 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::ApigeeRegistry::V1::Artifact.
  p item
end

Overloads:

  • #list_artifacts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::ListArtifactsRequest, ::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_artifacts(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApigeeRegistry::V1::Artifact>

    Pass arguments to list_artifacts 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 parent, which owns this collection of artifacts. Format: {parent}

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

      The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

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

      A page token, received from a previous ListArtifacts call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListArtifacts must match the call that provided the page token.

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

      An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2957

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ListArtifactsRequest

  # 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
  call_metadata = @config.rpcs.list_artifacts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_artifacts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_artifacts.retry_policy

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

  @registry_stub.list_artifacts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @registry_stub, :list_artifacts, "artifacts", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


376
377
378
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 376

def logger
  @registry_stub.logger
end

#replace_artifact(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact #replace_artifact(artifact: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Artifact

Used to replace a specified artifact.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Artifact.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
3318
3319
3320
3321
3322
3323
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 3290

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::ReplaceArtifactRequest

  # 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
  call_metadata = @config.rpcs.replace_artifact.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.replace_artifact.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.replace_artifact.retry_policy

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

  @registry_stub.replace_artifact request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rollback_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #rollback_api_deployment(name: nil, revision_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #rollback_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to rollback_api_deployment via a request object, either of type Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest, ::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_api_deployment(name: nil, revision_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to rollback_api_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 deployment being rolled back.

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

      Required. The revision ID to roll back to. It must be a revision of the same deployment.

      Example: c7cfa2a8

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2778

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest

  # 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
  call_metadata = @config.rpcs.rollback_api_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rollback_api_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.rollback_api_deployment.retry_policy

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

  @registry_stub.rollback_api_deployment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rollback_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #rollback_api_spec(name: nil, revision_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #rollback_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to rollback_api_spec via a request object, either of type Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest, ::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_api_spec(name: nil, revision_id: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to rollback_api_spec 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 spec being rolled back.

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

      Required. The revision ID to roll back to. It must be a revision of the same spec.

      Example: c7cfa2a8

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2001

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest

  # 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
  call_metadata = @config.rpcs.rollback_api_spec.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rollback_api_spec.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.rollback_api_spec.retry_policy

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

  @registry_stub.rollback_api_spec request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#tag_api_deployment_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #tag_api_deployment_revision(name: nil, tag: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Adds a tag to a specified revision of a deployment.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #tag_api_deployment_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::TagApiDeploymentRevisionRequest, ::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.

  • #tag_api_deployment_revision(name: nil, tag: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

    Pass arguments to tag_api_deployment_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The name of the deployment to be tagged, including the revision ID.

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

      Required. The tag to apply. The tag should be at most 40 characters, and match [a-z][a-z0-9-]{3,39}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2604

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::TagApiDeploymentRevisionRequest

  # 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
  call_metadata = @config.rpcs.tag_api_deployment_revision.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.tag_api_deployment_revision.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.tag_api_deployment_revision.retry_policy

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

  @registry_stub.tag_api_deployment_revision request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#tag_api_spec_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #tag_api_spec_revision(name: nil, tag: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Adds a tag to a specified revision of a spec.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #tag_api_spec_revision(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::TagApiSpecRevisionRequest, ::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.

  • #tag_api_spec_revision(name: nil, tag: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

    Pass arguments to tag_api_spec_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The name of the spec to be tagged, including the revision ID.

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

      Required. The tag to apply. The tag should be at most 40 characters, and match [a-z][a-z0-9-]{3,39}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1827

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::TagApiSpecRevisionRequest

  # 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
  call_metadata = @config.rpcs.tag_api_spec_revision.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.tag_api_spec_revision.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.tag_api_spec_revision.retry_policy

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

  @registry_stub.tag_api_spec_revision request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


277
278
279
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 277

def universe_domain
  @registry_stub.universe_domain
end

#update_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api #update_api(api: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

Used to modify a specified API.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::Api.
p result

Overloads:

  • #update_api(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiRequest, ::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_api(api: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::Api

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

    • api (::Google::Cloud::ApigeeRegistry::V1::Api, ::Hash) (defaults to: nil) —

      Required. The API to update.

      The name field is used to identify the API to update. Format: projects/*/locations/*/apis/*

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true, and the API is not found, a new API will be created. In this situation, update_mask is ignored.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 703

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::UpdateApiRequest

  # 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
  call_metadata = @config.rpcs.update_api.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_api.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_api.retry_policy

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

  @registry_stub.update_api request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment #update_api_deployment(api_deployment: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

Used to modify a specified deployment.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiDeployment.
p result

Overloads:

  • #update_api_deployment(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiDeploymentRequest, ::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_api_deployment(api_deployment: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment

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

    • api_deployment (::Google::Cloud::ApigeeRegistry::V1::ApiDeployment, ::Hash) (defaults to: nil) —

      Required. The deployment to update.

      The name field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true, and the deployment is not found, a new deployment will be created. In this situation, update_mask is ignored.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 2439

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::UpdateApiDeploymentRequest

  # 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
  call_metadata = @config.rpcs.update_api_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_api_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_api_deployment.retry_policy

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

  @registry_stub.update_api_deployment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec #update_api_spec(api_spec: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

Used to modify a specified spec.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiSpec.
p result

Overloads:

  • #update_api_spec(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiSpecRequest, ::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_api_spec(api_spec: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiSpec

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

    • api_spec (::Google::Cloud::ApigeeRegistry::V1::ApiSpec, ::Hash) (defaults to: nil) —

      Required. The spec to update.

      The name field is used to identify the spec to update. Format: projects/*/locations/*/apis/*/versions/*/specs/*

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true, and the spec is not found, a new spec will be created. In this situation, update_mask is ignored.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1663

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::UpdateApiSpecRequest

  # 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
  call_metadata = @config.rpcs.update_api_spec.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_api_spec.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_api_spec.retry_policy

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

  @registry_stub.update_api_spec request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion #update_api_version(api_version: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

Used to modify a specified version.

Examples:

Basic example

require "google/cloud/apigee_registry/v1"

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

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

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

# The returned object is of type Google::Cloud::ApigeeRegistry::V1::ApiVersion.
p result

Overloads:

  • #update_api_version(request, options = nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

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

    Parameters:

    • request (::Google::Cloud::ApigeeRegistry::V1::UpdateApiVersionRequest, ::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_api_version(api_version: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::ApigeeRegistry::V1::ApiVersion

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

    • api_version (::Google::Cloud::ApigeeRegistry::V1::ApiVersion, ::Hash) (defaults to: nil) —

      Required. The version to update.

      The name field is used to identify the version to update. Format: projects/*/locations/*/apis/*/versions/*

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true, and the version is not found, a new version will be created. In this situation, update_mask is ignored.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/google/cloud/apigee_registry/v1/registry/rest/client.rb', line 1142

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApigeeRegistry::V1::UpdateApiVersionRequest

  # 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
  call_metadata = @config.rpcs.update_api_version.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApigeeRegistry::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_api_version.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_api_version.retry_policy

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

  @registry_stub.update_api_version request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end