Class: Google::Apis::ApihubV1::APIhubService

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

Overview

API hub API

Examples:

require 'google/apis/apihub_v1'

Apihub = Google::Apis::ApihubV1 # Alias the module
service = Apihub::APIhubService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAPIhubService

Returns a new instance of APIhubService.



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

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

Instance Attribute Details

#keyString

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/apihub_v1/service.rb', line 40

def key
  @key
end

#quota_userString

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/apihub_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::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.

  • google_longrunning_cancel_operation_request_object (Google::Apis::ApihubV1::GoogleLongrunningCancelOperationRequest) (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



3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
# File 'lib/google/apis/apihub_v1/service.rb', line 3187

def cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

#collect_project_location_api_data(location, google_cloud_apihub_v1_collect_api_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Collect API data from a source and push it to Hub's collect layer.

Parameters:

  • location (String)

    Required. The regional location of the API hub instance and its resources. Format: projects/project/locations/location``

  • google_cloud_apihub_v1_collect_api_data_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1CollectApiDataRequest) (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



76
77
78
79
80
81
82
83
84
85
86
# File 'lib/google/apis/apihub_v1/service.rb', line 76

def collect_project_location_api_data(location, google_cloud_apihub_v1_collect_api_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+location}:collectApiData', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1CollectApiDataRequest::Representation
  command.request_object = google_cloud_apihub_v1_collect_api_data_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  command.params['location'] = location unless location.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_api(parent, google_cloud_apihub_v1_api_object = nil, api_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Api

Create an API resource in the API hub. Once an API resource is created, versions can be added to it.

Parameters:

  • parent (String)

    Required. The parent resource for the API resource. Format: projects/project /locations/location``

  • google_cloud_apihub_v1_api_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Api) (defaults to: nil)
  • api_id (String) (defaults to: nil)

    Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.

  • 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



609
610
611
612
613
614
615
616
617
618
619
620
# File 'lib/google/apis/apihub_v1/service.rb', line 609

def create_project_location_api(parent, google_cloud_apihub_v1_api_object = nil, api_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apis', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Api::Representation
  command.request_object = google_cloud_apihub_v1_api_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Api::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Api
  command.params['parent'] = parent unless parent.nil?
  command.query['apiId'] = api_id unless api_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_api_hub_instance(parent, google_cloud_apihub_v1_api_hub_instance_object = nil, api_hub_instance_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Provisions instance resources for the API Hub.

Parameters:

  • parent (String)

    Required. The parent resource for the Api Hub instance resource. Format: projects/project/locations/location``

  • google_cloud_apihub_v1_api_hub_instance_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance) (defaults to: nil)
  • api_hub_instance_id (String) (defaults to: nil)

    Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are /a-z[0-9]-_/.

  • 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
440
# File 'lib/google/apis/apihub_v1/service.rb', line 429

def create_project_location_api_hub_instance(parent, google_cloud_apihub_v1_api_hub_instance_object = nil, api_hub_instance_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apiHubInstances', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance::Representation
  command.request_object = google_cloud_apihub_v1_api_hub_instance_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['apiHubInstanceId'] = api_hub_instance_id unless api_hub_instance_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_api_version(parent, google_cloud_apihub_v1_version_object = nil, version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Version

Create an API version for an API resource in the API hub.

Parameters:

  • parent (String)

    Required. The parent resource for API version. Format: projects/project/ locations/location/apis/api``

  • google_cloud_apihub_v1_version_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Version) (defaults to: nil)
  • version_id (String) (defaults to: nil)

    Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/project/ locations/location/apis/api/versions/version``, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/.

  • 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



892
893
894
895
896
897
898
899
900
901
902
903
# File 'lib/google/apis/apihub_v1/service.rb', line 892

def create_project_location_api_version(parent, google_cloud_apihub_v1_version_object = nil, version_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/versions', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Version::Representation
  command.request_object = google_cloud_apihub_v1_version_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Version::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Version
  command.params['parent'] = parent unless parent.nil?
  command.query['versionId'] = version_id unless version_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_api_version_operation(parent, google_cloud_apihub_v1_api_operation_object = nil, api_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation

Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.

Parameters:

  • parent (String)

    Required. The parent resource for the operation resource. Format: projects/ project/locations/location/apis/api/versions/version``

  • google_cloud_apihub_v1_api_operation_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation) (defaults to: nil)
  • api_operation_id (String) (defaults to: nil)

    Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub. * If not provided, a system generated id will be used. This value should be 4- 500 characters, overall resource name which will be of format projects/ project/locations/location/apis/api/versions/version/operations/ operation``, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.

  • 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



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
# File 'lib/google/apis/apihub_v1/service.rb', line 1187

def create_project_location_api_version_operation(parent, google_cloud_apihub_v1_api_operation_object = nil, api_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/operations', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation::Representation
  command.request_object = google_cloud_apihub_v1_api_operation_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['apiOperationId'] = api_operation_id unless api_operation_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_api_version_spec(parent, google_cloud_apihub_v1_spec_object = nil, spec_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Spec

Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of contents or source_uri must be provided. If contents is provided, then spec_type must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the projects/ project/locations/location/attributes/system-spec-type attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.

Parameters:

  • parent (String)

    Required. The parent resource for Spec. Format: projects/project/locations/ location/apis/api/versions/version``

  • google_cloud_apihub_v1_spec_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Spec) (defaults to: nil)
  • spec_id (String) (defaults to: nil)

    Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/project/locations/location/apis/api/ versions/version/specs/spec``, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.

  • 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



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'lib/google/apis/apihub_v1/service.rb', line 1453

def create_project_location_api_version_spec(parent, google_cloud_apihub_v1_spec_object = nil, spec_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/specs', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec::Representation
  command.request_object = google_cloud_apihub_v1_spec_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec
  command.params['parent'] = parent unless parent.nil?
  command.query['specId'] = spec_id unless spec_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_attribute(parent, google_cloud_apihub_v1_attribute_object = nil, attribute_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute

Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as SYSTEM_DEFINED and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.

Parameters:

  • parent (String)

    Required. The parent resource for Attribute. Format: projects/project/ locations/location``

  • google_cloud_apihub_v1_attribute_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute) (defaults to: nil)
  • attribute_id (String) (defaults to: nil)

    Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4- 500 characters, and valid characters are /a-z[0-9]-_/.

  • 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



1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
# File 'lib/google/apis/apihub_v1/service.rb', line 1811

def create_project_location_attribute(parent, google_cloud_apihub_v1_attribute_object = nil, attribute_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attributes', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute::Representation
  command.request_object = google_cloud_apihub_v1_attribute_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute
  command.params['parent'] = parent unless parent.nil?
  command.query['attributeId'] = attribute_id unless attribute_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_curation(parent, google_cloud_apihub_v1_curation_object = nil, curation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Curation

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

Parameters:

  • parent (String)

    Required. The parent resource for the curation resource. Format: projects/ project/locations/location``

  • google_cloud_apihub_v1_curation_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Curation) (defaults to: nil)
  • curation_id (String) (defaults to: nil)

    Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.

  • 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



2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
# File 'lib/google/apis/apihub_v1/service.rb', line 2037

def create_project_location_curation(parent, google_cloud_apihub_v1_curation_object = nil, curation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/curations', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation::Representation
  command.request_object = google_cloud_apihub_v1_curation_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation
  command.params['parent'] = parent unless parent.nil?
  command.query['curationId'] = curation_id unless curation_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_dependency(parent, google_cloud_apihub_v1_dependency_object = nil, dependency_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency

Create a dependency between two entities in the API hub.

Parameters:

  • parent (String)

    Required. The parent resource for the dependency resource. Format: projects/ project/locations/location``

  • google_cloud_apihub_v1_dependency_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency) (defaults to: nil)
  • dependency_id (String) (defaults to: nil)

    Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are a-z[0-9]-_.

  • 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



2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
# File 'lib/google/apis/apihub_v1/service.rb', line 2243

def create_project_location_dependency(parent, google_cloud_apihub_v1_dependency_object = nil, dependency_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dependencies', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency::Representation
  command.request_object = google_cloud_apihub_v1_dependency_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency
  command.params['parent'] = parent unless parent.nil?
  command.query['dependencyId'] = dependency_id unless dependency_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_deployment(parent, google_cloud_apihub_v1_deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment

Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.

Parameters:

  • parent (String)

    Required. The parent resource for the deployment resource. Format: projects/ project/locations/location``

  • google_cloud_apihub_v1_deployment_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment) (defaults to: nil)
  • deployment_id (String) (defaults to: nil)

    Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4- 500 characters, and valid characters are /a-z[0-9]-_/.

  • 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



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
# File 'lib/google/apis/apihub_v1/service.rb', line 2455

def create_project_location_deployment(parent, google_cloud_apihub_v1_deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/deployments', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment::Representation
  command.request_object = google_cloud_apihub_v1_deployment_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment
  command.params['parent'] = parent unless parent.nil?
  command.query['deploymentId'] = deployment_id unless deployment_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_external_api(parent, google_cloud_apihub_v1_external_api_object = nil, external_api_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi

Create an External API resource in the API hub.

Parameters:

  • parent (String)

    Required. The parent resource for the External API resource. Format: projects/ project/locations/location``

  • google_cloud_apihub_v1_external_api_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi) (defaults to: nil)
  • external_api_id (String) (defaults to: nil)

    Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4- 500 characters, and valid characters are /a-z[0-9]-_/.

  • 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



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'lib/google/apis/apihub_v1/service.rb', line 2871

def create_project_location_external_api(parent, google_cloud_apihub_v1_external_api_object = nil, external_api_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/externalApis', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi::Representation
  command.request_object = google_cloud_apihub_v1_external_api_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi
  command.params['parent'] = parent unless parent.nil?
  command.query['externalApiId'] = external_api_id unless external_api_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_host_project_registration(parent, google_cloud_apihub_v1_host_project_registration_object = nil, host_project_registration_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration

Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.

Parameters:

  • parent (String)

    Required. The parent resource for the host project. Format: projects/project /locations/location``

  • google_cloud_apihub_v1_host_project_registration_object (Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration) (defaults to: nil)
  • host_project_registration_id (String) (defaults to: nil)

    Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field.

  • 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



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
# File 'lib/google/apis/apihub_v1/service.rb', line 3058

def create_project_location_host_project_registration(parent, google_cloud_apihub_v1_host_project_registration_object = nil, host_project_registration_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/hostProjectRegistrations', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration::Representation
  command.request_object = google_cloud_apihub_v1_host_project_registration_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration
  command.params['parent'] = parent unless parent.nil?
  command.query['hostProjectRegistrationId'] = host_project_registration_id unless host_project_registration_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_plugin(parent, google_cloud_apihub_v1_plugin_object = nil, plugin_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin

Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.

Parameters:

  • parent (String)

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

  • google_cloud_apihub_v1_plugin_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin) (defaults to: nil)
  • plugin_id (String) (defaults to: nil)

    Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format projects/project/ locations/location/plugins/plugin``, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.

  • 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



3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
# File 'lib/google/apis/apihub_v1/service.rb', line 3344

def create_project_location_plugin(parent, google_cloud_apihub_v1_plugin_object = nil, plugin_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/plugins', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin::Representation
  command.request_object = google_cloud_apihub_v1_plugin_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin
  command.params['parent'] = parent unless parent.nil?
  command.query['pluginId'] = plugin_id unless plugin_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_plugin_instance(parent, google_cloud_apihub_v1_plugin_instance_object = nil, plugin_instance_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Creates a Plugin instance in the API hub.

Parameters:

  • parent (String)

    Required. The parent of the plugin instance resource. Format: projects/ project/locations/location/plugins/plugin``

  • google_cloud_apihub_v1_plugin_instance_object (Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance) (defaults to: nil)
  • plugin_instance_id (String) (defaults to: nil)

    Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource.

    • If not provided, a system generated id will be used. This value should be 4- 63 characters, and valid characters are /a-z[0-9]-_/.
  • 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



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
# File 'lib/google/apis/apihub_v1/service.rb', line 3642

def create_project_location_plugin_instance(parent, google_cloud_apihub_v1_plugin_instance_object = nil, plugin_instance_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/instances', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance::Representation
  command.request_object = google_cloud_apihub_v1_plugin_instance_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['pluginInstanceId'] = plugin_instance_id unless plugin_instance_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_runtime_project_attachment(parent, google_cloud_apihub_v1_runtime_project_attachment_object = nil, runtime_project_attachment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment

Attaches a runtime project to the host project.

Parameters:

  • parent (String)

    Required. The parent resource for the Runtime Project Attachment. Format: projects/project/locations/location``

  • google_cloud_apihub_v1_runtime_project_attachment_object (Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment) (defaults to: nil)
  • runtime_project_attachment_id (String) (defaults to: nil)

    Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.

  • 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



4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
# File 'lib/google/apis/apihub_v1/service.rb', line 4021

def create_project_location_runtime_project_attachment(parent, google_cloud_apihub_v1_runtime_project_attachment_object = nil, runtime_project_attachment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/runtimeProjectAttachments', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment::Representation
  command.request_object = google_cloud_apihub_v1_runtime_project_attachment_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment
  command.params['parent'] = parent unless parent.nil?
  command.query['runtimeProjectAttachmentId'] = runtime_project_attachment_id unless runtime_project_attachment_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_api(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::Empty

Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.

Parameters:

  • name (String)

    Required. The name of the API resource to delete. Format: projects/project/ locations/location/apis/api``

  • force (Boolean) (defaults to: nil)

    Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.

  • 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



647
648
649
650
651
652
653
654
655
656
# File 'lib/google/apis/apihub_v1/service.rb', line 647

def delete_project_location_api(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.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_api_hub_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Deletes the API hub instance. Deleting the API hub instance will also result in the removal of all associated runtime project attachments and the host project registration.

Parameters:

  • name (String)

    Required. The name of the Api Hub instance to delete. Format: projects/ project/locations/location/apiHubInstances/apiHubInstance``.

  • 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



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

def delete_project_location_api_hub_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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_api_version(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::Empty

Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.

Parameters:

  • name (String)

    Required. The name of the version to delete. Format: projects/project/ locations/location/apis/api/versions/version``

  • force (Boolean) (defaults to: nil)

    Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs.

  • 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



930
931
932
933
934
935
936
937
938
939
# File 'lib/google/apis/apihub_v1/service.rb', line 930

def delete_project_location_api_version(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.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_api_version_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::Empty

Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.

Parameters:

  • name (String)

    Required. The name of the operation resource to delete. Format: projects/ project/locations/location/apis/api/versions/version/operations/ 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



1224
1225
1226
1227
1228
1229
1230
1231
1232
# File 'lib/google/apis/apihub_v1/service.rb', line 1224

def delete_project_location_api_version_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete a spec. Deleting a spec will also delete the associated operations from the version.

Parameters:

  • name (String)

    Required. The name of the spec to delete. Format: projects/project/ locations/location/apis/api/versions/version/specs/spec``

  • 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



1488
1489
1490
1491
1492
1493
1494
1495
1496
# File 'lib/google/apis/apihub_v1/service.rb', line 1488

def delete_project_location_api_version_spec(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.

Parameters:

  • name (String)

    Required. The name of the attribute to delete. Format: projects/project/ locations/location/attributes/attribute``

  • 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



1847
1848
1849
1850
1851
1852
1853
1854
1855
# File 'lib/google/apis/apihub_v1/service.rb', line 1847

def delete_project_location_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

Parameters:

  • name (String)

    Required. The name of the curation resource to delete. Format: projects/ project/locations/location/curations/curation``

  • 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



2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'lib/google/apis/apihub_v1/service.rb', line 2072

def delete_project_location_curation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete the dependency resource.

Parameters:

  • name (String)

    Required. The name of the dependency resource to delete. Format: projects/ project/locations/location/dependencies/dependency``

  • 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



2277
2278
2279
2280
2281
2282
2283
2284
2285
# File 'lib/google/apis/apihub_v1/service.rb', line 2277

def delete_project_location_dependency(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete a deployment resource in the API hub.

Parameters:

  • name (String)

    Required. The name of the deployment resource to delete. Format: projects/ project/locations/location/deployments/deployment``

  • 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



2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'lib/google/apis/apihub_v1/service.rb', line 2489

def delete_project_location_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

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

Delete an External API resource in the API hub.

Parameters:

  • name (String)

    Required. The name of the External API resource to delete. Format: projects/ project/locations/location/externalApis/externalApi``

  • 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



2905
2906
2907
2908
2909
2910
2911
2912
2913
# File 'lib/google/apis/apihub_v1/service.rb', line 2905

def delete_project_location_external_api(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::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



3222
3223
3224
3225
3226
3227
3228
3229
3230
# File 'lib/google/apis/apihub_v1/service.rb', line 3222

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

#delete_project_location_plugin(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.

Parameters:

  • name (String)

    Required. The name of the Plugin resource to delete. Format: projects/ project/locations/location/plugins/plugin``

  • 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



3379
3380
3381
3382
3383
3384
3385
3386
3387
# File 'lib/google/apis/apihub_v1/service.rb', line 3379

def delete_project_location_plugin(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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_plugin_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Deletes a plugin instance in the API hub.

Parameters:

  • name (String)

    Required. The name of the plugin instance to delete. Format: projects/ project/locations/location/plugins/plugin/instances/instance``.

  • 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



3676
3677
3678
3679
3680
3681
3682
3683
3684
# File 'lib/google/apis/apihub_v1/service.rb', line 3676

def delete_project_location_plugin_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::Empty

Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.

Parameters:

  • name (String)

    Required. The name of the Runtime Project Attachment to delete. Format: projects/project/locations/location/runtimeProjectAttachments/ runtime_project_attachment``

  • 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



4057
4058
4059
4060
4061
4062
4063
4064
4065
# File 'lib/google/apis/apihub_v1/service.rb', line 4057

def delete_project_location_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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_project_location_plugin(name, google_cloud_apihub_v1_disable_plugin_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin

Disables a plugin. The state of the plugin after disabling is DISABLED

Parameters:

  • name (String)

    Required. The name of the plugin to disable. Format: projects/project/ locations/location/plugins/plugin``.

  • google_cloud_apihub_v1_disable_plugin_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1DisablePluginRequest) (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



3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
# File 'lib/google/apis/apihub_v1/service.rb', line 3411

def disable_project_location_plugin(name, google_cloud_apihub_v1_disable_plugin_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:disable', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1DisablePluginRequest::Representation
  command.request_object = google_cloud_apihub_v1_disable_plugin_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin
  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_project_location_plugin_instance_action(name, google_cloud_apihub_v1_disable_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Disables a plugin instance in the API hub.

Parameters:

  • name (String)

    Required. The name of the plugin instance to disable. Format: projects/ project/locations/location/plugins/plugin/instances/instance``

  • google_cloud_apihub_v1_disable_plugin_instance_action_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1DisablePluginInstanceActionRequest) (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



3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
# File 'lib/google/apis/apihub_v1/service.rb', line 3708

def disable_project_location_plugin_instance_action(name, google_cloud_apihub_v1_disable_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:disableAction', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1DisablePluginInstanceActionRequest::Representation
  command.request_object = google_cloud_apihub_v1_disable_plugin_instance_action_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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_project_location_plugin(name, google_cloud_apihub_v1_enable_plugin_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin

Enables a plugin. The state of the plugin after enabling is ENABLED

Parameters:

  • name (String)

    Required. The name of the plugin to enable. Format: projects/project/ locations/location/plugins/plugin``.

  • google_cloud_apihub_v1_enable_plugin_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1EnablePluginRequest) (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



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
# File 'lib/google/apis/apihub_v1/service.rb', line 3445

def enable_project_location_plugin(name, google_cloud_apihub_v1_enable_plugin_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:enable', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1EnablePluginRequest::Representation
  command.request_object = google_cloud_apihub_v1_enable_plugin_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin
  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_project_location_plugin_instance_action(name, google_cloud_apihub_v1_enable_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Enables a plugin instance in the API hub.

Parameters:

  • name (String)

    Required. The name of the plugin instance to enable. Format: projects/ project/locations/location/plugins/plugin/instances/instance``

  • google_cloud_apihub_v1_enable_plugin_instance_action_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1EnablePluginInstanceActionRequest) (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



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
# File 'lib/google/apis/apihub_v1/service.rb', line 3742

def enable_project_location_plugin_instance_action(name, google_cloud_apihub_v1_enable_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:enableAction', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1EnablePluginInstanceActionRequest::Representation
  command.request_object = google_cloud_apihub_v1_enable_plugin_instance_action_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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

#execute_project_location_plugin_instance_action(name, google_cloud_apihub_v1_execute_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Executes a plugin instance in the API hub.

Parameters:

  • name (String)

    Required. The name of the plugin instance to execute. Format: projects/ project/locations/location/plugins/plugin/instances/instance``

  • google_cloud_apihub_v1_execute_plugin_instance_action_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ExecutePluginInstanceActionRequest) (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



3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
# File 'lib/google/apis/apihub_v1/service.rb', line 3776

def execute_project_location_plugin_instance_action(name, google_cloud_apihub_v1_execute_plugin_instance_action_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:executeAction', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExecutePluginInstanceActionRequest::Representation
  command.request_object = google_cloud_apihub_v1_execute_plugin_instance_action_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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

#fetch_project_location_api_version_spec_additional_spec_content(name, spec_content_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse

Fetch additional spec content.

Parameters:

  • name (String)

    Required. The name of the spec whose contents need to be retrieved. Format: projects/project/locations/location/apis/api/versions/version/specs/ spec``

  • spec_content_type (String) (defaults to: nil)

    Optional. The type of the spec contents to be retrieved.

  • 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



1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'lib/google/apis/apihub_v1/service.rb', line 1522

def fetch_project_location_api_version_spec_additional_spec_content(name, spec_content_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetchAdditionalSpecContent', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse
  command.params['name'] = name unless name.nil?
  command.query['specContentType'] = spec_content_type unless spec_content_type.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::ApihubV1::GoogleCloudLocationLocation

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



108
109
110
111
112
113
114
115
116
# File 'lib/google/apis/apihub_v1/service.rb', line 108

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudLocationLocation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudLocationLocation
  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_addon(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Addon

Get an addon.

Parameters:

  • name (String)

    Required. The name of the addon to get. Format: projects/project/locations/ location/addons/addon``.

  • 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



307
308
309
310
311
312
313
314
315
# File 'lib/google/apis/apihub_v1/service.rb', line 307

def get_project_location_addon(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Addon::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Addon
  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_api(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Api

Get API resource details including the API versions contained in it.

Parameters:

  • name (String)

    Required. The name of the API resource to retrieve. Format: projects/project /locations/location/apis/api``

  • 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



679
680
681
682
683
684
685
686
687
# File 'lib/google/apis/apihub_v1/service.rb', line 679

def get_project_location_api(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Api::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Api
  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_api_hub_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance

Gets details of a single API Hub instance.

Parameters:

  • name (String)

    Required. The name of the Api Hub instance to retrieve. Format: projects/ project/locations/location/apiHubInstances/apiHubInstance``.

  • 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



496
497
498
499
500
501
502
503
504
# File 'lib/google/apis/apihub_v1/service.rb', line 496

def get_project_location_api_hub_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance
  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_api_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Version

Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.

Parameters:

  • name (String)

    Required. The name of the API version to retrieve. Format: projects/project/ locations/location/apis/api/versions/version``

  • 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



964
965
966
967
968
969
970
971
972
# File 'lib/google/apis/apihub_v1/service.rb', line 964

def get_project_location_api_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Version::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Version
  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_api_version_definition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Definition

Get details about a definition in an API version.

Parameters:

  • name (String)

    Required. The name of the definition to retrieve. Format: projects/project/ locations/location/apis/api/versions/version/definitions/definition``

  • 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



1144
1145
1146
1147
1148
1149
1150
1151
1152
# File 'lib/google/apis/apihub_v1/service.rb', line 1144

def get_project_location_api_version_definition(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Definition::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Definition
  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_api_version_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation

Get details about a particular operation in API version.

Parameters:

  • name (String)

    Required. The name of the operation to retrieve. Format: projects/project/ locations/location/apis/api/versions/version/operations/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



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'lib/google/apis/apihub_v1/service.rb', line 1255

def get_project_location_api_version_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation
  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_api_version_spec(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Spec

Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.

Parameters:

  • name (String)

    Required. The name of the spec to retrieve. Format: projects/project/ locations/location/apis/api/versions/version/specs/spec``

  • 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



1556
1557
1558
1559
1560
1561
1562
1563
1564
# File 'lib/google/apis/apihub_v1/service.rb', line 1556

def get_project_location_api_version_spec(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec
  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_api_version_spec_contents(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1SpecContents

Get spec contents.

Parameters:

  • name (String)

    Required. The name of the spec whose contents need to be retrieved. Format: projects/project/locations/location/apis/api/versions/version/specs/ spec``

  • 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



1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'lib/google/apis/apihub_v1/service.rb', line 1588

def get_project_location_api_version_spec_contents(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:contents', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1SpecContents::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1SpecContents
  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_attribute(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute

Get details about the attribute.

Parameters:

  • name (String)

    Required. The name of the attribute to retrieve. Format: projects/project/ locations/location/attributes/attribute``

  • 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



1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'lib/google/apis/apihub_v1/service.rb', line 1878

def get_project_location_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute
  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_curation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Curation

Get curation resource details.

Parameters:

  • name (String)

    Required. The name of the curation resource to retrieve. Format: projects/ project/locations/location/curations/curation``

  • 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



2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'lib/google/apis/apihub_v1/service.rb', line 2103

def get_project_location_curation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation
  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_dependency(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency

Get details about a dependency resource in the API hub.

Parameters:

  • name (String)

    Required. The name of the dependency resource to retrieve. Format: projects/ project/locations/location/dependencies/dependency``

  • 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



2308
2309
2310
2311
2312
2313
2314
2315
2316
# File 'lib/google/apis/apihub_v1/service.rb', line 2308

def get_project_location_dependency(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency
  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_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment

Get details about a deployment and the API versions linked to it.

Parameters:

  • name (String)

    Required. The name of the deployment resource to retrieve. Format: projects/ project/locations/location/deployments/deployment``

  • 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



2520
2521
2522
2523
2524
2525
2526
2527
2528
# File 'lib/google/apis/apihub_v1/service.rb', line 2520

def get_project_location_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment
  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_discovered_api_observation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiObservation

Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.

Parameters:

  • name (String)

    Required. The name of the DiscoveredApiObservation to retrieve. Format: projects/project/locations/location/discoveredApiObservations/ discovered_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



2712
2713
2714
2715
2716
2717
2718
2719
2720
# File 'lib/google/apis/apihub_v1/service.rb', line 2712

def get_project_location_discovered_api_observation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiObservation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiObservation
  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_discovered_api_observation_discovered_api_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiOperation

Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.

Parameters:

  • name (String)

    Required. The name of the DiscoveredApiOperation to retrieve. Format: projects/ project/locations/location/discoveredApiObservations/ discovered_api_observation/discoveredApiOperations/discovered_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



2788
2789
2790
2791
2792
2793
2794
2795
2796
# File 'lib/google/apis/apihub_v1/service.rb', line 2788

def get_project_location_discovered_api_observation_discovered_api_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1DiscoveredApiOperation
  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_external_api(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi

Get details about an External API resource in the API hub.

Parameters:

  • name (String)

    Required. The name of the External API resource to retrieve. Format: projects/ project/locations/location/externalApis/externalApi``

  • 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



2936
2937
2938
2939
2940
2941
2942
2943
2944
# File 'lib/google/apis/apihub_v1/service.rb', line 2936

def get_project_location_external_api(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi
  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_host_project_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration

Get a host project registration.

Parameters:

  • name (String)

    Required. Host project registration resource name. projects/project/ locations/location/hostProjectRegistrations/host_project_registration_id

  • 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



3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'lib/google/apis/apihub_v1/service.rb', line 3092

def get_project_location_host_project_registration(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1HostProjectRegistration
  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::ApihubV1::GoogleLongrunningOperation

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



3253
3254
3255
3256
3257
3258
3259
3260
3261
# File 'lib/google/apis/apihub_v1/service.rb', line 3253

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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_plugin(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin

Get an API Hub plugin.

Parameters:

  • name (String)

    Required. The name of the plugin to retrieve. Format: projects/project/ locations/location/plugins/plugin``.

  • 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



3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'lib/google/apis/apihub_v1/service.rb', line 3478

def get_project_location_plugin(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Plugin
  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_plugin_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance

Get an API Hub plugin instance.

Parameters:

  • name (String)

    Required. The name of the plugin instance to retrieve. Format: projects/ project/locations/location/plugins/plugin/instances/instance``

  • 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



3809
3810
3811
3812
3813
3814
3815
3816
3817
# File 'lib/google/apis/apihub_v1/service.rb', line 3809

def get_project_location_plugin_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance
  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_plugin_style_guide(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide

Get the style guide being used for linting.

Parameters:

  • name (String)

    Required. The name of the spec to retrieve. Format: projects/project/ locations/location/plugins/plugin/styleGuide.

  • 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



3509
3510
3511
3512
3513
3514
3515
3516
3517
# File 'lib/google/apis/apihub_v1/service.rb', line 3509

def get_project_location_plugin_style_guide(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide
  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_plugin_style_guide_contents(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuideContents

Get the contents of the style guide.

Parameters:

  • name (String)

    Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is projects/project/locations/location/plugins/plugin/ styleGuide.

  • 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



3984
3985
3986
3987
3988
3989
3990
3991
3992
# File 'lib/google/apis/apihub_v1/service.rb', line 3984

def get_project_location_plugin_style_guide_contents(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:contents', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuideContents::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuideContents
  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_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment

Gets a runtime project attachment.

Parameters:

  • name (String)

    Required. The name of the API resource to retrieve. Format: projects/project /locations/location/runtimeProjectAttachments/runtime_project_attachment``

  • 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



4088
4089
4090
4091
4092
4093
4094
4095
4096
# File 'lib/google/apis/apihub_v1/service.rb', line 4088

def get_project_location_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1RuntimeProjectAttachment
  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

#lint_project_location_api_version_spec(name, google_cloud_apihub_v1_lint_spec_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::Empty

Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.

Parameters:

  • name (String)

    Required. The name of the spec to be linted. Format: projects/project/ locations/location/apis/api/versions/version/specs/spec``

  • google_cloud_apihub_v1_lint_spec_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1LintSpecRequest) (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



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
# File 'lib/google/apis/apihub_v1/service.rb', line 1622

def lint_project_location_api_version_spec(name, google_cloud_apihub_v1_lint_spec_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:lint', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1LintSpecRequest::Representation
  command.request_object = google_cloud_apihub_v1_lint_spec_request_object
  command.response_representation = Google::Apis::ApihubV1::Empty::Representation
  command.response_class = Google::Apis::ApihubV1::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

#list_project_location_addons(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse

List addons.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of addons. The only supported filter is plugin_instance_name. It can be used to filter addons that are enabled for a given plugin instance. The format of the filter is plugin_instance_name = "projects/project/locations/location/plugins/ plugin/instances/instance".

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of hub addons to return. The service may return fewer than this value. If unspecified, at most 50 hub addons 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 ListAddons call. Provide this to retrieve the subsequent page. When paginating, all other parameters ( except page_size) provided to ListAddons 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



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

def list_project_location_addons(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/addons', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_api_version_operations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListApiOperationsResponse

List operations in an API version.

Parameters:

  • parent (String)

    Required. The parent which owns this collection of operations i.e., the API version. Format: projects/project/locations/location/apis/api/versions/ version``

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the ApiOperation are eligible for filtering: * name - The ApiOperation resource name. Allowed comparison operators: =. * details. http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =. * details.http_operation. method - The http operation method type. Allowed comparison operators: =. * details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =. * create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools. ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * attributes.projects/test-project-id/locations/test-location-id/ attributes/ user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/ test-project-id/locations/test-location-id/ attributes/user-defined-attribute- id.enum_values.values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/ user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * details.deprecated = True

    • The ApiOperation is deprecated. * details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00: 00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00: 00 UTC. * details.http_operation.method = GET OR details.http_operation. method = POST. - The http operation of the method of ApiOperation is GET or POST. * details.deprecated = True AND attributes.projects/test-project-id/ locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b. string_values.values: test - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is test.
  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations 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 ListApiOperations call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListApiOperations 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



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
# File 'lib/google/apis/apihub_v1/service.rb', line 1348

def list_project_location_api_version_operations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/operations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListApiOperationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListApiOperationsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_api_version_specs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListSpecsResponse

List specs corresponding to a particular API resource.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of specs. Format: projects/ project/locations/location/apis/api/versions/version``

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are not case sensitive. The following fields in the Spec are eligible for filtering: * display_name - The display name of the Spec. Allowed comparison operators: =. * create_time - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/ html/rfc3339] format. Allowed comparison operators: > and <. * spec_type. enum_values.values.id - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: :. * spec_type. enum_values.values.display_name - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: : . * lint_response.json_values.values - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: :. * mime_type - The MIME type of the Spec. Allowed comparison operators: =. * attributes.projects/test-project-id/locations/test-location-id/ attributes/ user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/ test-project-id/locations/test-location-id/ attributes/user-defined-attribute- id.enum_values.values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/ user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * spec_type.enum_values. values.id: rest-id - The filter string specifies that the id of the allowed value associated with the spec_type attribute is rest-id. * spec_type. enum_values.values.display_name: \"Rest Display Name\" - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is Rest Display Name. * spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021- 08-10T12:00:00Z\" - The id of the allowed value associated with the spec_type attribute is grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id - The id of the allowed value associated with the spec_type attribute is rest-id or grpc-id. * spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project- id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b. enum_values.values.id: test - The filter string specifies that the id of the allowed value associated with the spec_type attribute is rest-id and the id of the allowed value associated with the user defined attribute of type enum is test.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs 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 ListSpecs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSpecs 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



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
# File 'lib/google/apis/apihub_v1/service.rb', line 1722

def list_project_location_api_version_specs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/specs', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListSpecsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListSpecsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_api_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListVersionsResponse

List API versions of an API resource in the API hub.

Parameters:

  • parent (String)

    Required. The parent which owns this collection of API versions i.e., the API resource Format: projects/project/locations/location/apis/api``

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Version are eligible for filtering: * display_name - The display name of the Version. Allowed comparison operators: =. * create_time

    • The time at which the Version was created. The value should be in the ( RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * lifecycle.enum_values.values.id - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: :. * lifecycle.enum_values.values.display_name - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: :. * compliance.enum_values.values. id - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: :. * compliance.enum_values.values. display_name - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: :. * accreditation.enum_values.values.id - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: :. * accreditation.enum_values.values.display_name - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: :. * attributes.projects/test- project-id/locations/test-location-id/ attributes/user-defined-attribute-id. enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/test-project-id/ locations/test-location-id/ attributes/user-defined-attribute-id.enum_values. values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes. projects/test-project-id/locations/test-location-id/ attributes/user-defined- attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test- project-id/locations/test-location-id/ attributes/user-defined-attribute-id. json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user- defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * lifecycle.enum_values.values.id: preview-id - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id. * lifecycle.enum_values. values.display_name: \"Preview Display Name\" - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is Preview Display Name. * lifecycle.enum_values. values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * compliance.enum_values.values.id: gdpr-id OR compliance.enum_values. values.id: pci-dss-id - The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id. * lifecycle.enum_values. values.id: preview-id AND attributes.projects/test-project-id/locations/test- location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values. values: test - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id and the value of the user defined attribute of type string is test.
  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions 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 ListVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters ( except page_size) provided to ListVersions 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



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'lib/google/apis/apihub_v1/service.rb', line 1070

def list_project_location_api_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListVersionsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListVersionsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_apis(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListApisResponse

List API resources in the API hub.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are not case sensitive. The following fields in the ApiResource are eligible for filtering: * owner.email - The email of the team which owns the ApiResource. Allowed comparison operators: =. * create_time - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * display_name - The display name of the ApiResource. Allowed comparison operators: =. * target_user.enum_values. values.id - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is :. * target_user. enum_values.values.display_name - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is :. * team.enum_values.values.id - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is :. * team.enum_values.values.display_name - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is :. * business_unit.enum_values.values.id - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is :. * business_unit.enum_values.values.display_name - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is :. * maturity_level. enum_values.values.id - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is :. * maturity_level.enum_values.values.display_name - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is :. * api_style.enum_values.values.id - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is :. * api_style.enum_values.values.display_name - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is :. * attributes.projects/test- project-id/locations/test-location-id/ attributes/user-defined-attribute-id. enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/test-project-id/ locations/test-location-id/ attributes/user-defined-attribute-id.enum_values. values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes. projects/test-project-id/locations/test-location-id/ attributes/user-defined- attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test- project-id/locations/test-location-id/ attributes/user-defined-attribute-id. json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user- defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. A filter function is also supported in the filter string. The filter function is id(name). The id(name) function returns the id of the resource name. For example, id(name) = \"api-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/apis/api-1\" provided the parent is projects/test-project-id/locations/test-location-id. Another supported filter function is plugins(source_metadata). This function filters for resources that are associated with a specific plugin. For example, plugins(source_metadata) : "projects/test-project-id/locations/test-location- id/plugins/test-plugin-id" will return resources sourced from the given plugin. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * owner.email = \"apihub@google.com\" - - The owner team email is apihub@google.com. * owner.email = \"apihub@google.com\" AND create_time < \ "2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The owner team email is apihub@google.com and the api was created before 2021- 08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * owner.email = \" apihub@google.com\" OR team.enum_values.values.id: apihub-team-id - The filter string specifies the APIs where the owner team email is apihub@google. com or the id of the allowed value associated with the team attribute is apihub-team-id. * owner.email = \"apihub@google.com\" OR team.enum_values. values.display_name: ApiHub Team - The filter string specifies the APIs where the owner team email is apihub@google.com or the display name of the allowed value associated with the team attribute is ApiHub Team. * owner.email = \" apihub@google.com\" AND attributes.projects/test-project-id/locations/test- location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values. values.id: test_enum_id AND attributes.projects/test-project-id/locations/test- location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values. values: test_string_value - The filter string specifies the APIs where the owner team email is apihub@google.com and the id of the allowed value associated with the user defined attribute of type enum is test_enum_id and the value of the user defined attribute of type string is test..

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis 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 ListApis call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListApis 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



806
807
808
809
810
811
812
813
814
815
816
817
# File 'lib/google/apis/apihub_v1/service.rb', line 806

def list_project_location_apis(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apis', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListApisResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListApisResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_attributes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListAttributesResponse

List all attributes.

Parameters:

  • parent (String)

    Required. The parent resource for Attribute. Format: projects/project/ locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Attribute are eligible for filtering: * display_name - The display name of the Attribute. Allowed comparison operators: =. * definition_type - The definition type of the attribute. Allowed comparison operators: =. * scope - The scope of the attribute. Allowed comparison operators: =. * data_type - The type of the data of the attribute. Allowed comparison operators: =. * mandatory - Denotes whether the attribute is mandatory or not. Allowed comparison operators: =. * create_time - The time at which the Attribute was created. The value should be in the (RFC3339)[ https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * display_name = production - - The display name of the attribute is production. * (display_name = production) AND (create_time < \"2021-08- 15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") - The display name of the attribute is production and the attribute was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * display_name = production OR scope = api - The attribute where the display name is production or the scope is api.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes 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 ListAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAttributes 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



1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
# File 'lib/google/apis/apihub_v1/service.rb', line 1945

def list_project_location_attributes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAttributesResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAttributesResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_curations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListCurationsResponse

List curation resources in the API hub.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are case insensitive. The following fields in the curation resource are eligible for filtering: * create_time - The time at which the curation was created. The value should be in the (RFC3339)[https:/ /tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < . * display_name - The display name of the curation. Allowed comparison operators: =. * state - The state of the curation. Allowed comparison operators: =. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * create_time < \"2021-08-15T14:50:00Z\" AND create_time > \" 2021-08-10T12:00:00Z\" - The curation resource was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations 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 ListCurations call. Provide this to retrieve the subsequent page. When paginating, all other parameters ( except page_size) provided to ListCurations 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



2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
# File 'lib/google/apis/apihub_v1/service.rb', line 2162

def list_project_location_curations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/curations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListCurationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListCurationsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_dependencies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListDependenciesResponse

List dependencies based on the provided filter and pagination parameters.

Parameters:

  • parent (String)

    Required. The parent which owns this collection of dependency resources. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is =. Filters are not case sensitive. The following fields in the Dependency are eligible for filtering: * consumer.operation_resource_name - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: =. * consumer.external_api_resource_name - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: =. * supplier.operation_resource_name - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: =. * supplier.external_api_resource_name - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: =. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. For example, consumer.operation_resource_name = \" projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier. operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/ operations/o1\" - The dependencies with either consumer or supplier operation resource name as projects/p1/locations/global/apis/a1/versions/v1/operations/ o1.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies 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 ListDependencies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDependencies 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



2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'lib/google/apis/apihub_v1/service.rb', line 2374

def list_project_location_dependencies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dependencies', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDependenciesResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDependenciesResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_deployments(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListDeploymentsResponse

List deployment resources in the API hub.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Deployments are eligible for filtering: * display_name - The display name of the Deployment. Allowed comparison operators: =. * create_time - The time at which the Deployment was created. The value should be in the (RFC3339)[ https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * resource_uri - A URI to the deployment resource. Allowed comparison operators: =. * api_versions - The API versions linked to this deployment. Allowed comparison operators: :. * source_project - The project/organization at source for the deployment. Allowed comparison operators: =. * source_environment - The environment at source for the deployment. Allowed comparison operators: =. * deployment_type.enum_values. values.id - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: :. * deployment_type. enum_values.values.display_name - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: :. * slo.string_values.values -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: : . * environment.enum_values.values.id - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: :. * environment.enum_values.values.display_name - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: :. * attributes.projects/test-project-id/ locations/test-location-id/ attributes/user-defined-attribute-id.enum_values. values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user- defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/test-project-id/locations/ test-location-id/ attributes/user-defined-attribute-id.enum_values.values. display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes. projects/test-project-id/locations/test-location-id/ attributes/user-defined- attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test- project-id/locations/test-location-id/ attributes/user-defined-attribute-id. json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user- defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. A filter function is also supported in the filter string. The filter function is id(name). The id(name) function returns the id of the resource name. For example, id(name) = \"deployment-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/ deployments/deployment-1\" provided the parent is projects/test-project-id/ locations/test-location-id. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * environment.enum_values.values.id: staging-id - The allowed value id of the environment attribute associated with the Deployment is staging-id. * environment.enum_values.values.display_name: \" Staging Deployment\" - The allowed value display name of the environment attribute associated with the Deployment is Staging Deployment. * environment.enum_values.values.id: production-id AND create_time < \"2021-08- 15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The allowed value id of the environment attribute associated with the Deployment is production- id and Deployment was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\" - The allowed value id of the environment attribute Deployment is production-id or string value of the slo attribute is 99.99%. * environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/ 17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is staging-id and the value of the user defined attribute of type string is test.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments 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 ListDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListDeployments 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



2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
# File 'lib/google/apis/apihub_v1/service.rb', line 2635

def list_project_location_deployments(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_discovered_api_observation_discovered_api_operations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiOperationsResponse

Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (defaults to: nil)

    Optional. DiscoveredApiOperations 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 ListDiscoveredApiApiOperations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDiscoveredApiApiOperations 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



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
# File 'lib/google/apis/apihub_v1/service.rb', line 2830

def list_project_location_discovered_api_observation_discovered_api_operations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/discoveredApiOperations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiOperationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiOperationsResponse
  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_discovered_api_observations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiObservationsResponse

Lists all the DiscoveredAPIObservations in a given project and location.

Parameters:

  • parent (String)

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

  • 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



2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
# File 'lib/google/apis/apihub_v1/service.rb', line 2753

def list_project_location_discovered_api_observations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/discoveredApiObservations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiObservationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListDiscoveredApiObservationsResponse
  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_external_apis(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListExternalApisResponse

List External API resources in the API hub.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of External API resources. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis 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 ListExternalApis call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListExternalApis 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



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
# File 'lib/google/apis/apihub_v1/service.rb', line 2977

def list_project_location_external_apis(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/externalApis', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListExternalApisResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListExternalApisResponse
  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_host_project_registrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListHostProjectRegistrationsResponse

Lists host project registrations.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of host projects. Format: projects/*/locations/*

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the HostProjectRegistration are eligible for filtering: * name - The name of the HostProjectRegistration. * create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[ https://tools.ietf.org/html/rfc3339] format. * gcp_project - The Google cloud project associated with the HostProjectRegistration.

  • order_by (String) (defaults to: nil)

    Optional. Hint for how to order the results.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations 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 ListHostProjectRegistrations call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListHostProjectRegistrations 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



3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
# File 'lib/google/apis/apihub_v1/service.rb', line 3145

def list_project_location_host_project_registrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/hostProjectRegistrations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListHostProjectRegistrationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListHostProjectRegistrationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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::ApihubV1::GoogleLongrunningListOperationsResponse

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



3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/google/apis/apihub_v1/service.rb', line 3298

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, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningListOperationsResponse
  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_location_plugin_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginInstancesResponse

List all the plugins in a given project and location. - can be used as wildcard value for plugin_id

Parameters:

  • parent (String)

    Required. The parent resource where this plugin will be created. Format: projects/project/locations/location/plugins/plugin``. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the PluginInstances are eligible for filtering: * state - The state of the Plugin Instance. Allowed comparison operators: =. * source_project_id - The source project id of the Plugin Instance. Allowed comparison operators: = . A filter function is also supported in the filter string. The filter function is id(name). The id(name) function returns the id of the resource name. For example, id(name) = \"plugin-instance-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/ instances/plugin-instance-1\" provided the parent is projects/test-project- id/locations/test-location-id/plugins/plugin-1. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * state = ENABLED - The plugin instance is in enabled state.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins 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 ListPluginInstances call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPluginInstances 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



3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
# File 'lib/google/apis/apihub_v1/service.rb', line 3872

def list_project_location_plugin_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/instances', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginInstancesResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginInstancesResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_plugins(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginsResponse

List all the plugins in a given project and location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Plugins are eligible for filtering: * plugin_category - The category of the Plugin. Allowed comparison operators: =. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * plugin_category = ON_RAMP - The plugin is of category on ramp.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins 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 ListPlugins call. Provide this to retrieve the subsequent page. When paginating, all other parameters ( except page_size) provided to ListPlugins 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



3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
# File 'lib/google/apis/apihub_v1/service.rb', line 3563

def list_project_location_plugins(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/plugins', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListPluginsResponse
  command.params['parent'] = parent unless parent.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

#list_project_location_runtime_project_attachments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse

List runtime projects attached to the host project.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the RuntimeProjectAttachment are eligible for filtering: * name - The name of the RuntimeProjectAttachment. * create_time - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[ https://tools.ietf.org/html/rfc3339] format. * runtime_project - The Google cloud project associated with the RuntimeProjectAttachment.

  • order_by (String) (defaults to: nil)

    Optional. Hint for how to order the results.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments 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 ListRuntimeProjectAttachments call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListRuntimeProjectAttachments 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



4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
# File 'lib/google/apis/apihub_v1/service.rb', line 4142

def list_project_location_runtime_project_attachments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/runtimeProjectAttachments', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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_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::ApihubV1::GoogleCloudLocationListLocationsResponse

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



160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/google/apis/apihub_v1/service.rb', line 160

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, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudLocationListLocationsResponse
  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

#lookup_project_location_api_hub_instance(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1LookupApiHubInstanceResponse

Looks up an Api Hub instance in a given Google Cloud project. There will always be only one Api Hub instance for a Google Cloud project across all locations.

Parameters:

  • parent (String)

    Required. There will always be only one Api Hub instance for a Google Cloud project across all locations. The parent resource for the Api Hub instance resource. Format: projects/project/locations/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



530
531
532
533
534
535
536
537
538
# File 'lib/google/apis/apihub_v1/service.rb', line 530

def lookup_project_location_api_hub_instance(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apiHubInstances:lookup', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1LookupApiHubInstanceResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1LookupApiHubInstanceResponse
  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

#lookup_project_location_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse

Look up a runtime project attachment. This API can be called in the context of any project.

Parameters:

  • name (String)

    Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: projects/project/locations/ 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



197
198
199
200
201
202
203
204
205
# File 'lib/google/apis/apihub_v1/service.rb', line 197

def lookup_project_location_runtime_project_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:lookupRuntimeProjectAttachment', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse
  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

#manage_project_location_addon_config(name, google_cloud_apihub_v1_manage_addon_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Manage addon config. This RPC is used for managing the config of the addon. Calling this RPC moves the addon into an updating state until the long-running operation succeeds.

Parameters:

  • name (String)

    Required. The name of the addon for which the config is to be managed. Format: projects/project/locations/location/addons/addon``.

  • google_cloud_apihub_v1_manage_addon_config_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ManageAddonConfigRequest) (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



390
391
392
393
394
395
396
397
398
399
400
# File 'lib/google/apis/apihub_v1/service.rb', line 390

def manage_project_location_addon_config(name, google_cloud_apihub_v1_manage_addon_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:manageConfig', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ManageAddonConfigRequest::Representation
  command.request_object = google_cloud_apihub_v1_manage_addon_config_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  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

#manage_project_location_plugin_instance_source_data(name, google_cloud_apihub_v1_manage_plugin_instance_source_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse

Manages data for a given plugin instance.

Parameters:

  • name (String)

    Required. The name of the plugin instance for which data needs to be managed. Format: projects/project/locations/location/plugins/plugin/instances/ instance``

  • google_cloud_apihub_v1_manage_plugin_instance_source_data_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest) (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



3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'lib/google/apis/apihub_v1/service.rb', line 3908

def manage_project_location_plugin_instance_source_data(name, google_cloud_apihub_v1_manage_plugin_instance_source_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:manageSourceData', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest::Representation
  command.request_object = google_cloud_apihub_v1_manage_plugin_instance_source_data_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse
  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

#patch_project_location_api(name, google_cloud_apihub_v1_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Api

Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.

Parameters:

  • name (String)

    Identifier. The name of the API resource in the API Hub. Format: projects/ project/locations/location/apis/api``

  • google_cloud_apihub_v1_api_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Api) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



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

def patch_project_location_api(name, google_cloud_apihub_v1_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Api::Representation
  command.request_object = google_cloud_apihub_v1_api_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Api::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Api
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_api_hub_instance(name, google_cloud_apihub_v1_api_hub_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleLongrunningOperation

Update an Api Hub instance. The following fields in the ApiHubInstance can be updated: * disable_search * vertex_location * agent_registry_sync_config The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. Format: projects/project/locations/location/apiHubInstances/ apiHubInstance``.

  • google_cloud_apihub_v1_api_hub_instance_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to update.

  • 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



566
567
568
569
570
571
572
573
574
575
576
577
# File 'lib/google/apis/apihub_v1/service.rb', line 566

def patch_project_location_api_hub_instance(name, google_cloud_apihub_v1_api_hub_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiHubInstance::Representation
  command.request_object = google_cloud_apihub_v1_api_hub_instance_object
  command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_api_version(name, google_cloud_apihub_v1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Version

Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. The name of the version. Format: projects/project/locations/ location/apis/api/versions/version``

  • google_cloud_apihub_v1_version_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Version) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
# File 'lib/google/apis/apihub_v1/service.rb', line 1110

def patch_project_location_api_version(name, google_cloud_apihub_v1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Version::Representation
  command.request_object = google_cloud_apihub_v1_version_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Version::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Version
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_api_version_operation(name, google_cloud_apihub_v1_api_operation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation

Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details. documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool. description * details.mcp_tool.input_schema * details.mcp_tool.output_schema * details.input_schema * details.output_schema * details.mcp_tool.annotations. title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool. annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations. additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.

Parameters:

  • name (String)

    Identifier. The name of the operation. Format: projects/project/locations/ location/apis/api/versions/version/operations/operation``

  • google_cloud_apihub_v1_api_operation_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
# File 'lib/google/apis/apihub_v1/service.rb', line 1397

def patch_project_location_api_version_operation(name, google_cloud_apihub_v1_api_operation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation::Representation
  command.request_object = google_cloud_apihub_v1_api_operation_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ApiOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_api_version_spec(name, google_cloud_apihub_v1_spec_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Spec

Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. The name of the spec. Format: projects/project/locations/ location/apis/api/versions/version/specs/spec``

  • google_cloud_apihub_v1_spec_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Spec) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'lib/google/apis/apihub_v1/service.rb', line 1766

def patch_project_location_api_version_spec(name, google_cloud_apihub_v1_spec_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec::Representation
  command.request_object = google_cloud_apihub_v1_spec_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Spec
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_attribute(name, google_cloud_apihub_v1_attribute_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute

Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. The name of the attribute in the API Hub. Format: projects/ project/locations/location/attributes/attribute``

  • google_cloud_apihub_v1_attribute_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
# File 'lib/google/apis/apihub_v1/service.rb', line 1994

def patch_project_location_attribute(name, google_cloud_apihub_v1_attribute_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute::Representation
  command.request_object = google_cloud_apihub_v1_attribute_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Attribute
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_curation(name, google_cloud_apihub_v1_curation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Curation

Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. The name of the curation. Format: projects/project/locations/ location/curations/curation``

  • google_cloud_apihub_v1_curation_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Curation) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to update.

  • 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



2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
# File 'lib/google/apis/apihub_v1/service.rb', line 2201

def patch_project_location_curation(name, google_cloud_apihub_v1_curation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation::Representation
  command.request_object = google_cloud_apihub_v1_curation_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Curation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dependency(name, google_cloud_apihub_v1_dependency_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency

Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description

Parameters:

  • name (String)

    Identifier. The name of the dependency in the API Hub. Format: projects/ project/locations/location/dependencies/dependency``

  • google_cloud_apihub_v1_dependency_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'lib/google/apis/apihub_v1/service.rb', line 2412

def patch_project_location_dependency(name, google_cloud_apihub_v1_dependency_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency::Representation
  command.request_object = google_cloud_apihub_v1_dependency_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Dependency
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_deployment(name, google_cloud_apihub_v1_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment

Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment

  • attributes * source_project * source_environment * management_url * source_uri The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. The name of the deployment. Format: projects/project/locations/ location/deployments/deployment``

  • google_cloud_apihub_v1_deployment_object (Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
# File 'lib/google/apis/apihub_v1/service.rb', line 2676

def patch_project_location_deployment(name, google_cloud_apihub_v1_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment::Representation
  command.request_object = google_cloud_apihub_v1_deployment_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Deployment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_external_api(name, google_cloud_apihub_v1_external_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi

Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.

Parameters:

  • name (String)

    Identifier. Format: projects/project/locations/location/externalApi/ externalApi``.

  • google_cloud_apihub_v1_external_api_object (Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • 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



3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
# File 'lib/google/apis/apihub_v1/service.rb', line 3015

def patch_project_location_external_api(name, google_cloud_apihub_v1_external_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi::Representation
  command.request_object = google_cloud_apihub_v1_external_api_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ExternalApi
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_plugin_instance(name, google_cloud_apihub_v1_plugin_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance

Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.

Parameters:

  • name (String)

    Identifier. The unique name of the plugin instance resource. Format: projects/ project/locations/location/plugins/plugin/instances/instance``

  • google_cloud_apihub_v1_plugin_instance_object (Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to update.

  • 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



3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
# File 'lib/google/apis/apihub_v1/service.rb', line 3948

def patch_project_location_plugin_instance(name, google_cloud_apihub_v1_plugin_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance::Representation
  command.request_object = google_cloud_apihub_v1_plugin_instance_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1PluginInstance
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_project_location_api_views(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse

Retrieve API views.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. The filter expression.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of results to return. Default to 100.

  • page_token (String) (defaults to: nil)

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

  • view (String) (defaults to: nil)

    Required. The view type to return.

  • 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



237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/google/apis/apihub_v1/service.rb', line 237

def retrieve_project_location_api_views(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}:retrieveApiViews', options)
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse
  command.params['parent'] = parent unless parent.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['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_resources(location, google_cloud_apihub_v1_search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1SearchResourcesResponse

Search across API-Hub resources.

Parameters:

  • location (String)

    Required. The resource name of the location which will be of the type projects/project_id/locations/location_id``. This field is used to identify the instance of API-Hub in which resources should be searched.

  • google_cloud_apihub_v1_search_resources_request_object (Google::Apis::ApihubV1::GoogleCloudApihubV1SearchResourcesRequest) (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



274
275
276
277
278
279
280
281
282
283
284
# File 'lib/google/apis/apihub_v1/service.rb', line 274

def search_project_location_resources(location, google_cloud_apihub_v1_search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+location}:searchResources', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1SearchResourcesRequest::Representation
  command.request_object = google_cloud_apihub_v1_search_resources_request_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1SearchResourcesResponse::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1SearchResourcesResponse
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_plugin_style_guide(name, google_cloud_apihub_v1_style_guide_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide

Update the styleGuide to be used for liniting in by API hub.

Parameters:

  • name (String)

    Identifier. The name of the style guide. Format: projects/project/locations/ location/plugins/plugin/styleGuide

  • google_cloud_apihub_v1_style_guide_object (Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to update.

  • 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



3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
# File 'lib/google/apis/apihub_v1/service.rb', line 3600

def update_project_location_plugin_style_guide(name, google_cloud_apihub_v1_style_guide_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide::Representation
  command.request_object = google_cloud_apihub_v1_style_guide_object
  command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide::Representation
  command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1StyleGuide
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end