A base abstract class for APIhub requests.
APIhubServiceThe APIhub Service.
APIhubService.ScopeAvailable OAuth 2.0 scopes for use with the API hub API.
APIhubService.ScopeConstantsAvailable OAuth 2.0 scope constants for use with the API hub API.
ProjectsResourceThe "projects" collection of methods.
ProjectsResource.LocationsResourceThe "locations" collection of methods.
ProjectsResource.LocationsResource.ApiHubInstancesResourceThe "apiHubInstances" collection of methods.
ProjectsResource.LocationsResource.ApiHubInstancesResource.CreateRequestProvisions instance resources for the API Hub.
ProjectsResource.LocationsResource.ApiHubInstancesResource.DeleteRequestDeletes the API hub instance.
ProjectsResource.LocationsResource.ApiHubInstancesResource.GetRequestGets details of a single API Hub instance.
ProjectsResource.LocationsResource.ApiHubInstancesResource.LookupRequestLooks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.
ProjectsResource.LocationsResource.ApisResourceThe "apis" collection of methods.
ProjectsResource.LocationsResource.ApisResource.CreateRequestCreate an API resource in the API hub. Once an API resource is created, versions can be added to it.
ProjectsResource.LocationsResource.ApisResource.DeleteRequestDelete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
ProjectsResource.LocationsResource.ApisResource.GetRequestGet API resource details including the API versions contained in it.
ProjectsResource.LocationsResource.ApisResource.ListRequestList API resources in the API hub.
ProjectsResource.LocationsResource.ApisResource.PatchRequestUpdate 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 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResourceThe "versions" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.CreateRequestCreate an API version for an API resource in the API hub.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DefinitionsResourceThe "definitions" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DefinitionsResource.GetRequestGet details about a definition in an API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DeleteRequestDelete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.GetRequestGet 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.ListRequestList API versions of an API resource in the API hub.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.CreateRequestCreate 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.DeleteRequestDelete 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.GetRequestGet details about a particular operation in API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.ListRequestList operations in an API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.PatchRequestUpdate 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 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.PatchRequestUpdate API version. The following fields in the version can be updated currently: * display_name
The "specs" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.CreateRequestAdd 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.
Delete a spec. Deleting a spec will also delete the associated operations from the version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetContentsRequestGet spec contents.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetRequestGet 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.LintRequestLints 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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRequestList specs corresponding to a particular API resource.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.PatchRequestUpdate 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.
ProjectsResource.LocationsResource.AttributesResourceThe "attributes" collection of methods.
ProjectsResource.LocationsResource.AttributesResource.CreateRequestCreate 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.
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.
ProjectsResource.LocationsResource.AttributesResource.GetRequestGet details about the attribute.
ProjectsResource.LocationsResource.AttributesResource.ListRequestList all attributes.
ProjectsResource.LocationsResource.AttributesResource.PatchRequestUpdate 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.
ProjectsResource.LocationsResource.CollectApiDataRequestCollect API data from a source and push it to Hub's collect layer.
ProjectsResource.LocationsResource.CurationsResourceThe "curations" collection of methods.
ProjectsResource.LocationsResource.CurationsResource.CreateRequestCreate a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
ProjectsResource.LocationsResource.CurationsResource.DeleteRequestDelete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.
ProjectsResource.LocationsResource.CurationsResource.GetRequestGet curation resource details.
ProjectsResource.LocationsResource.CurationsResource.ListRequestList curation resources in the API hub.
ProjectsResource.LocationsResource.CurationsResource.PatchRequestUpdate 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.
ProjectsResource.LocationsResource.DependenciesResourceThe "dependencies" collection of methods.
ProjectsResource.LocationsResource.DependenciesResource.CreateRequestCreate a dependency between two entities in the API hub.
ProjectsResource.LocationsResource.DependenciesResource.DeleteRequestDelete the dependency resource.
ProjectsResource.LocationsResource.DependenciesResource.GetRequestGet details about a dependency resource in the API hub.
ProjectsResource.LocationsResource.DependenciesResource.ListRequestList dependencies based on the provided filter and pagination parameters.
ProjectsResource.LocationsResource.DependenciesResource.PatchRequestUpdate a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description
ProjectsResource.LocationsResource.DeploymentsResourceThe "deployments" collection of methods.
ProjectsResource.LocationsResource.DeploymentsResource.CreateRequestCreate a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
ProjectsResource.LocationsResource.DeploymentsResource.DeleteRequestDelete a deployment resource in the API hub.
ProjectsResource.LocationsResource.DeploymentsResource.GetRequestGet details about a deployment and the API versions linked to it.
ProjectsResource.LocationsResource.DeploymentsResource.ListRequestList deployment resources in the API hub.
ProjectsResource.LocationsResource.DeploymentsResource.PatchRequestUpdate 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 The update_mask should be used to specify the fields being updated.
ProjectsResource.LocationsResource.ExternalApisResourceThe "externalApis" collection of methods.
ProjectsResource.LocationsResource.ExternalApisResource.CreateRequestCreate an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.DeleteRequestDelete an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.GetRequestGet details about an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.ListRequestList External API resources in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.PatchRequestUpdate an External API resource in the API hub. The following fields can be updated: * display_name
Gets information about a location.
ProjectsResource.LocationsResource.HostProjectRegistrationsResourceThe "hostProjectRegistrations" collection of methods.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.CreateRequestCreate 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.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.GetRequestGet a host project registration.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.ListRequestLists host project registrations.
ProjectsResource.LocationsResource.ListRequestLists information about the supported locations for this service.
ProjectsResource.LocationsResource.LookupRuntimeProjectAttachmentRequestLook up a runtime project attachment. This API can be called in the context of any project.
ProjectsResource.LocationsResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.CancelRequestStarts 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
.
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
.
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.
ProjectsResource.LocationsResource.OperationsResource.ListRequestLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
The "plugins" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.CreateRequestCreate an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
ProjectsResource.LocationsResource.PluginsResource.DeleteRequestDelete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
ProjectsResource.LocationsResource.PluginsResource.DisableRequestDisables a plugin. The state
of the plugin after disabling is DISABLED
Enables a plugin. The state
of the plugin after enabling is ENABLED
Get an API Hub plugin.
ProjectsResource.LocationsResource.PluginsResource.GetStyleGuideRequestGet the style guide being used for linting.
ProjectsResource.LocationsResource.PluginsResource.InstancesResourceThe "instances" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.CreateRequestCreates a Plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.DeleteRequestDeletes a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.DisableActionRequestDisables a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.EnableActionRequestEnables a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.ExecuteActionRequestExecutes a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.GetRequestGet an API Hub plugin instance.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.ListRequestList all the plugins in a given project and location. -
can be used as wildcard value for {plugin_id}
List all the plugins in a given project and location.
ProjectsResource.LocationsResource.PluginsResource.StyleGuideResourceThe "styleGuide" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.StyleGuideResource.GetContentsRequestGet the contents of the style guide.
ProjectsResource.LocationsResource.PluginsResource.UpdateStyleGuideRequestUpdate the styleGuide to be used for liniting in by API hub.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResourceThe "runtimeProjectAttachments" collection of methods.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.CreateRequestAttaches a runtime project to the host project.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.DeleteRequestDelete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.GetRequestGets a runtime project attachment.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.ListRequestList runtime projects attached to the host project.
ProjectsResource.LocationsResource.SearchResourcesRequestSearch across API-Hub resources.
Enums APIhubBaseServiceRequest<TResponse>.AltEnumData format for response.
APIhubBaseServiceRequest<TResponse>.XgafvEnumV1 error format.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4