Namespace Google.Apis.APIhub.v1
Classes
APIhubBaseServiceRequest<TResponse>
A base abstract class for APIhub requests.
APIhubService
The APIhub Service.
APIhubService.Scope
Available OAuth 2.0 scopes for use with the API hub API.
APIhubService.ScopeConstants
Available OAuth 2.0 scope constants for use with the API hub API.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.ApiHubInstancesResource
The "apiHubInstances" collection of methods.
ProjectsResource.LocationsResource.ApiHubInstancesResource.CreateRequest
Provisions instance resources for the API Hub.
ProjectsResource.LocationsResource.ApiHubInstancesResource.DeleteRequest
Deletes the API hub instance.
ProjectsResource.LocationsResource.ApiHubInstancesResource.GetRequest
Gets details of a single API Hub instance.
ProjectsResource.LocationsResource.ApiHubInstancesResource.LookupRequest
Looks 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.ApisResource
The "apis" collection of methods.
ProjectsResource.LocationsResource.ApisResource.CreateRequest
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
ProjectsResource.LocationsResource.ApisResource.DeleteRequest
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
ProjectsResource.LocationsResource.ApisResource.GetRequest
Get API resource details including the API versions contained in it.
ProjectsResource.LocationsResource.ApisResource.ListRequest
List API resources in the API hub.
ProjectsResource.LocationsResource.ApisResource.PatchRequest
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 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.VersionsResource
The "versions" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.CreateRequest
Create an API version for an API resource in the API hub.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DefinitionsResource
The "definitions" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DefinitionsResource.GetRequest
Get details about a definition in an API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.DeleteRequest
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.GetRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.ListRequest
List API versions of an API resource in the API hub.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.CreateRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.DeleteRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.GetRequest
Get details about a particular operation in API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.ListRequest
List operations in an API version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.OperationsResource.PatchRequest
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 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.PatchRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource
The "specs" collection of methods.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.CreateRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.DeleteRequest
Delete a spec. Deleting a spec will also delete the associated operations from the version.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetContentsRequest
Get spec contents.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.LintRequest
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.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRequest
List specs corresponding to a particular API resource.
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.PatchRequest
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.
ProjectsResource.LocationsResource.AttributesResource
The "attributes" collection of methods.
ProjectsResource.LocationsResource.AttributesResource.CreateRequest
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.
ProjectsResource.LocationsResource.AttributesResource.DeleteRequest
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.GetRequest
Get details about the attribute.
ProjectsResource.LocationsResource.AttributesResource.ListRequest
List all attributes.
ProjectsResource.LocationsResource.AttributesResource.PatchRequest
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.
ProjectsResource.LocationsResource.CollectApiDataRequest
Collect API data from a source and push it to Hub's collect layer.
ProjectsResource.LocationsResource.CurationsResource
The "curations" collection of methods.
ProjectsResource.LocationsResource.CurationsResource.CreateRequest
Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
ProjectsResource.LocationsResource.CurationsResource.DeleteRequest
Delete 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.GetRequest
Get curation resource details.
ProjectsResource.LocationsResource.CurationsResource.ListRequest
List curation resources in the API hub.
ProjectsResource.LocationsResource.CurationsResource.PatchRequest
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.
ProjectsResource.LocationsResource.DependenciesResource
The "dependencies" collection of methods.
ProjectsResource.LocationsResource.DependenciesResource.CreateRequest
Create a dependency between two entities in the API hub.
ProjectsResource.LocationsResource.DependenciesResource.DeleteRequest
Delete the dependency resource.
ProjectsResource.LocationsResource.DependenciesResource.GetRequest
Get details about a dependency resource in the API hub.
ProjectsResource.LocationsResource.DependenciesResource.ListRequest
List dependencies based on the provided filter and pagination parameters.
ProjectsResource.LocationsResource.DependenciesResource.PatchRequest
Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description
ProjectsResource.LocationsResource.DeploymentsResource
The "deployments" collection of methods.
ProjectsResource.LocationsResource.DeploymentsResource.CreateRequest
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
ProjectsResource.LocationsResource.DeploymentsResource.DeleteRequest
Delete a deployment resource in the API hub.
ProjectsResource.LocationsResource.DeploymentsResource.GetRequest
Get details about a deployment and the API versions linked to it.
ProjectsResource.LocationsResource.DeploymentsResource.ListRequest
List deployment resources in the API hub.
ProjectsResource.LocationsResource.DeploymentsResource.PatchRequest
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 The update_mask should be used to specify the fields being updated.
ProjectsResource.LocationsResource.ExternalApisResource
The "externalApis" collection of methods.
ProjectsResource.LocationsResource.ExternalApisResource.CreateRequest
Create an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.DeleteRequest
Delete an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.GetRequest
Get details about an External API resource in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.ListRequest
List External API resources in the API hub.
ProjectsResource.LocationsResource.ExternalApisResource.PatchRequest
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.
ProjectsResource.LocationsResource.GetRequest
Gets information about a location.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource
The "hostProjectRegistrations" collection of methods.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.CreateRequest
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.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.GetRequest
Get a host project registration.
ProjectsResource.LocationsResource.HostProjectRegistrationsResource.ListRequest
Lists host project registrations.
ProjectsResource.LocationsResource.ListRequest
Lists information about the supported locations for this service.
ProjectsResource.LocationsResource.LookupRuntimeProjectAttachmentRequest
Look up a runtime project attachment. This API can be called in the context of any project.
ProjectsResource.LocationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.CancelRequest
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
.
ProjectsResource.LocationsResource.OperationsResource.DeleteRequest
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
.
ProjectsResource.LocationsResource.OperationsResource.GetRequest
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.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED
.
ProjectsResource.LocationsResource.PluginsResource
The "plugins" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.CreateRequest
Create 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.DeleteRequest
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
ProjectsResource.LocationsResource.PluginsResource.DisableRequest
Disables a plugin. The state
of the plugin after disabling is DISABLED
ProjectsResource.LocationsResource.PluginsResource.EnableRequest
Enables a plugin. The state
of the plugin after enabling is ENABLED
ProjectsResource.LocationsResource.PluginsResource.GetRequest
Get an API Hub plugin.
ProjectsResource.LocationsResource.PluginsResource.GetStyleGuideRequest
Get the style guide being used for linting.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource
The "instances" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.CreateRequest
Creates a Plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.DeleteRequest
Deletes a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.DisableActionRequest
Disables a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.EnableActionRequest
Enables a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.ExecuteActionRequest
Executes a plugin instance in the API hub.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.GetRequest
Get an API Hub plugin instance.
ProjectsResource.LocationsResource.PluginsResource.InstancesResource.ListRequest
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
ProjectsResource.LocationsResource.PluginsResource.ListRequest
List all the plugins in a given project and location.
ProjectsResource.LocationsResource.PluginsResource.StyleGuideResource
The "styleGuide" collection of methods.
ProjectsResource.LocationsResource.PluginsResource.StyleGuideResource.GetContentsRequest
Get the contents of the style guide.
ProjectsResource.LocationsResource.PluginsResource.UpdateStyleGuideRequest
Update the styleGuide to be used for liniting in by API hub.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource
The "runtimeProjectAttachments" collection of methods.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.CreateRequest
Attaches a runtime project to the host project.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.DeleteRequest
Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.GetRequest
Gets a runtime project attachment.
ProjectsResource.LocationsResource.RuntimeProjectAttachmentsResource.ListRequest
List runtime projects attached to the host project.
ProjectsResource.LocationsResource.SearchResourcesRequest
Search across API-Hub resources.
Enums
APIhubBaseServiceRequest<TResponse>.AltEnum
Data format for response.
APIhubBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.