Class: Google::Apis::ApimV1alpha::APIManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/apim_v1alpha/service.rb

Overview

API Management API

Enables users to discover shadow APIs in existing Google Cloud infrastructure.

Examples:

require 'google/apis/apim_v1alpha'

Apim = Google::Apis::ApimV1alpha # Alias the module
service = Apim::APIManagementService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://apim.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ APIManagementService

Returns a new instance of APIManagementService.



47
48
49
50
51
52
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-apim_v1alpha',
        client_version: Google::Apis::ApimV1alpha::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#batch_edit_tags_api_observations(parent, batch_edit_tags_api_observations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::BatchEditTagsApiObservationsResponse

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

Parameters:

  • parent (String) —

    Required. The parent resource shared by all ApiObservations being edited. Format: projects/project/locations/location/observationJobs/ observation_job

  • batch_edit_tags_api_observations_request_object (Google::Apis::ApimV1alpha::BatchEditTagsApiObservationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 464

def batch_edit_tags_api_observations(parent, batch_edit_tags_api_observations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/apiObservations:batchEditTags', options)
  command.request_representation = Google::Apis::ApimV1alpha::BatchEditTagsApiObservationsRequest::Representation
  command.request_object = batch_edit_tags_api_observations_request_object
  command.response_representation = Google::Apis::ApimV1alpha::BatchEditTagsApiObservationsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::BatchEditTagsApiObservationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::ApimV1alpha::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 815

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
  command.request_representation = Google::Apis::ApimV1alpha::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ApimV1alpha::Empty::Representation
  command.response_class = Google::Apis::ApimV1alpha::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_observation_job(parent, observation_job_object = nil, observation_job_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.

Parameters:

  • parent (String) —

    Required. The parent resource where this ObservationJob will be created. Format: projects/project/locations/location

  • observation_job_object (Google::Apis::ApimV1alpha::ObservationJob) (defaults to: nil)
  • observation_job_id (String) (defaults to: nil) —

    Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.

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

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 252

def create_project_location_observation_job(parent, observation_job_object = nil, observation_job_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/observationJobs', options)
  command.request_representation = Google::Apis::ApimV1alpha::ObservationJob::Representation
  command.request_object = observation_job_object
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['observationJobId'] = observation_job_id unless observation_job_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_observation_source(parent, observation_source_object = nil, observation_source_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

Parameters:

  • parent (String) —

    Required. Value for parent.

  • observation_source_object (Google::Apis::ApimV1alpha::ObservationSource) (defaults to: nil)
  • observation_source_id (String) (defaults to: nil) —

    Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/.

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

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 665

def create_project_location_observation_source(parent, observation_source_object = nil, observation_source_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/observationSources', options)
  command.request_representation = Google::Apis::ApimV1alpha::ObservationSource::Representation
  command.request_object = observation_source_object
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['observationSourceId'] = observation_source_id unless observation_source_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_observation_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.

Parameters:

  • name (String) —

    Required. Name of the resource Format: projects/project/locations/location/ observationJobs/observation_job

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



289
290
291
292
293
294
295
296
297
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 289

def delete_project_location_observation_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_observation_source(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.

Parameters:

  • name (String) —

    Required. Name of the resource Format: projects/project/locations/location/ observationSources/source

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



702
703
704
705
706
707
708
709
710
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 702

def delete_project_location_observation_source(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



850
851
852
853
854
855
856
857
858
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 850

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Empty::Representation
  command.response_class = Google::Apis::ApimV1alpha::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_observation_job(name, disable_observation_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

Disables the given ObservationJob.

Parameters:

  • name (String) —

    Required. The name of the ObservationJob to disable. Format: projects/project /locations/location/observationJobs/job

  • disable_observation_job_request_object (Google::Apis::ApimV1alpha::DisableObservationJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 321

def disable_observation_job(name, disable_observation_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:disable', options)
  command.request_representation = Google::Apis::ApimV1alpha::DisableObservationJobRequest::Representation
  command.request_object = disable_observation_job_request_object
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_observation_job(name, enable_observation_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

Enables the given ObservationJob.

Parameters:

  • name (String) —

    Required. The name of the ObservationJob to enable. Format: projects/project/ locations/location/observationJobs/job

  • enable_observation_job_request_object (Google::Apis::ApimV1alpha::EnableObservationJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 355

def enable_observation_job(name, enable_observation_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:enable', options)
  command.request_representation = Google::Apis::ApimV1alpha::EnableObservationJobRequest::Representation
  command.request_object = enable_observation_job_request_object
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 74

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Location::Representation
  command.response_class = Google::Apis::ApimV1alpha::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_entitlement(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Entitlement

GetEntitlement returns the entitlement for the provided project.

Parameters:

  • name (String) —

    Required. The entitlement resource name Format: projects/project/locations/ location/entitlement

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



105
106
107
108
109
110
111
112
113
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 105

def get_project_location_entitlement(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Entitlement::Representation
  command.response_class = Google::Apis::ApimV1alpha::Entitlement
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_observation_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ObservationJob

GetObservationJob retrieves a single ObservationJob by name.

Parameters:

  • name (String) —

    Required. The name of the ObservationJob to retrieve. Format: projects/ project/locations/location/observationJobs/job

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



388
389
390
391
392
393
394
395
396
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 388

def get_project_location_observation_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::ObservationJob::Representation
  command.response_class = Google::Apis::ApimV1alpha::ObservationJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_observation_job_api_observation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ApiObservation

GetApiObservation retrieves a single ApiObservation by name.

Parameters:

  • name (String) —

    Required. The name of the ApiObservation to retrieve. Format: projects/ project/locations/location/observationJobs/observation_job/ apiObservations/api_observation

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 498

def get_project_location_observation_job_api_observation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::ApiObservation::Representation
  command.response_class = Google::Apis::ApimV1alpha::ApiObservation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_observation_job_api_observation_api_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ApiOperation

GetApiOperation retrieves a single ApiOperation by name.

Parameters:

  • name (String) —

    Required. The name of the ApiOperation to retrieve. Format: projects/project/ locations/location/observationJobs/observation_job/apiObservations/ api_observation/apiOperation/api_operation

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



574
575
576
577
578
579
580
581
582
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 574

def get_project_location_observation_job_api_observation_api_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::ApiOperation::Representation
  command.response_class = Google::Apis::ApimV1alpha::ApiOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_observation_source(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ObservationSource

GetObservationSource retrieves a single ObservationSource by name.

Parameters:

  • name (String) —

    Required. The name of the ObservationSource to retrieve. Format: projects/ project/locations/location/observationSources/source

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 733

def get_project_location_observation_source(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::ObservationSource::Representation
  command.response_class = Google::Apis::ApimV1alpha::ObservationSource
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



881
882
883
884
885
886
887
888
889
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 881

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::ApimV1alpha::Operation::Representation
  command.response_class = Google::Apis::ApimV1alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_api_observation_tags(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListApiObservationTagsResponse

ListApiObservationTags lists all extant tags on any observation in the given project.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of tags. Format: projects/ project/locations/location

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

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

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

    Optional. A page token, received from a previous ListApiObservationTags call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApiObservationTags must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 202

def list_project_location_api_observation_tags(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}:listApiObservationTags', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListApiObservationTagsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListApiObservationTagsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_observation_job_api_observation_api_operations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListApiOperationsResponse

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of ApiOperations. Format: projects/project/locations/location/observationJobs/observation_job/ apiObservations/api_observation

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

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

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

    Optional. A page token, received from a previous ListApiApiOperations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApiApiOperations must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 616

def list_project_location_observation_job_api_observation_api_operations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/apiOperations', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListApiOperationsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListApiOperationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_observation_job_api_observations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListApiObservationsResponse

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of ApiObservations. Format: projects/project/locations/location/observationJobs/observation_job

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

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

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

    Optional. A page token, received from a previous ListApiObservations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApiObservations must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 540

def list_project_location_observation_job_api_observations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/apiObservations', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListApiObservationsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListApiObservationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_observation_jobs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListObservationJobsResponse

ListObservationJobs gets all ObservationJobs for a given project and location.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of ObservationJobs. Format: projects/project/locations/location

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

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

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

    Optional. A page token, received from a previous ListObservationJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListObservationJobs must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 429

def list_project_location_observation_jobs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/observationJobs', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListObservationJobsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListObservationJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_observation_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListObservationSourcesResponse

ListObservationSources gets all ObservationSources for a given project and location.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of ObservationSources. Format: projects/project/locations/location

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

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

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

    Optional. A page token, received from a previous ListObservationSources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListObservationSources must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 775

def list_project_location_observation_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/observationSources', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListObservationSourcesResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListObservationSourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

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

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 926

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApimV1alpha::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil) —

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

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

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

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

    The maximum number of results to return. If not set, the service selects a default.

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

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/google/apis/apim_v1alpha/service.rb', line 157

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}/locations', options)
  command.response_representation = Google::Apis::ApimV1alpha::ListLocationsResponse::Representation
  command.response_class = Google::Apis::ApimV1alpha::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end