Variables
LintState_name, LintState_value
var (
LintState_name = map[int32]string{
0: "LINT_STATE_UNSPECIFIED",
1: "LINT_STATE_SUCCESS",
2: "LINT_STATE_ERROR",
}
LintState_value = map[string]int32{
"LINT_STATE_UNSPECIFIED": 0,
"LINT_STATE_SUCCESS": 1,
"LINT_STATE_ERROR": 2,
}
)
Enum value maps for LintState.
Linter_name, Linter_value
var (
Linter_name = map[int32]string{
0: "LINTER_UNSPECIFIED",
1: "SPECTRAL",
2: "OTHER",
}
Linter_value = map[string]int32{
"LINTER_UNSPECIFIED": 0,
"SPECTRAL": 1,
"OTHER": 2,
}
)
Enum value maps for Linter.
Severity_name, Severity_value
var (
Severity_name = map[int32]string{
0: "SEVERITY_UNSPECIFIED",
1: "SEVERITY_ERROR",
2: "SEVERITY_WARNING",
3: "SEVERITY_INFO",
4: "SEVERITY_HINT",
}
Severity_value = map[string]int32{
"SEVERITY_UNSPECIFIED": 0,
"SEVERITY_ERROR": 1,
"SEVERITY_WARNING": 2,
"SEVERITY_INFO": 3,
"SEVERITY_HINT": 4,
}
)
Enum value maps for Severity.
Spec_ParsingMode_name, Spec_ParsingMode_value
var (
Spec_ParsingMode_name = map[int32]string{
0: "PARSING_MODE_UNSPECIFIED",
1: "RELAXED",
2: "STRICT",
}
Spec_ParsingMode_value = map[string]int32{
"PARSING_MODE_UNSPECIFIED": 0,
"RELAXED": 1,
"STRICT": 2,
}
)
Enum value maps for Spec_ParsingMode.
Definition_Type_name, Definition_Type_value
var (
Definition_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "SCHEMA",
}
Definition_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"SCHEMA": 1,
}
)
Enum value maps for Definition_Type.
Attribute_DefinitionType_name, Attribute_DefinitionType_value
var (
Attribute_DefinitionType_name = map[int32]string{
0: "DEFINITION_TYPE_UNSPECIFIED",
1: "SYSTEM_DEFINED",
2: "USER_DEFINED",
}
Attribute_DefinitionType_value = map[string]int32{
"DEFINITION_TYPE_UNSPECIFIED": 0,
"SYSTEM_DEFINED": 1,
"USER_DEFINED": 2,
}
)
Enum value maps for Attribute_DefinitionType.
Attribute_Scope_name, Attribute_Scope_value
var (
Attribute_Scope_name = map[int32]string{
0: "SCOPE_UNSPECIFIED",
1: "API",
2: "VERSION",
3: "SPEC",
4: "API_OPERATION",
5: "DEPLOYMENT",
6: "DEPENDENCY",
7: "DEFINITION",
8: "EXTERNAL_API",
9: "PLUGIN",
}
Attribute_Scope_value = map[string]int32{
"SCOPE_UNSPECIFIED": 0,
"API": 1,
"VERSION": 2,
"SPEC": 3,
"API_OPERATION": 4,
"DEPLOYMENT": 5,
"DEPENDENCY": 6,
"DEFINITION": 7,
"EXTERNAL_API": 8,
"PLUGIN": 9,
}
)
Enum value maps for Attribute_Scope.
Attribute_DataType_name, Attribute_DataType_value
var (
Attribute_DataType_name = map[int32]string{
0: "DATA_TYPE_UNSPECIFIED",
1: "ENUM",
2: "JSON",
3: "STRING",
}
Attribute_DataType_value = map[string]int32{
"DATA_TYPE_UNSPECIFIED": 0,
"ENUM": 1,
"JSON": 2,
"STRING": 3,
}
)
Enum value maps for Attribute_DataType.
OpenApiSpecDetails_Format_name, OpenApiSpecDetails_Format_value
var (
OpenApiSpecDetails_Format_name = map[int32]string{
0: "FORMAT_UNSPECIFIED",
1: "OPEN_API_SPEC_2_0",
2: "OPEN_API_SPEC_3_0",
3: "OPEN_API_SPEC_3_1",
}
OpenApiSpecDetails_Format_value = map[string]int32{
"FORMAT_UNSPECIFIED": 0,
"OPEN_API_SPEC_2_0": 1,
"OPEN_API_SPEC_3_0": 2,
"OPEN_API_SPEC_3_1": 3,
}
)
Enum value maps for OpenApiSpecDetails_Format.
HttpOperation_Method_name, HttpOperation_Method_value
var (
HttpOperation_Method_name = map[int32]string{
0: "METHOD_UNSPECIFIED",
1: "GET",
2: "PUT",
3: "POST",
4: "DELETE",
5: "OPTIONS",
6: "HEAD",
7: "PATCH",
8: "TRACE",
}
HttpOperation_Method_value = map[string]int32{
"METHOD_UNSPECIFIED": 0,
"GET": 1,
"PUT": 2,
"POST": 3,
"DELETE": 4,
"OPTIONS": 5,
"HEAD": 6,
"PATCH": 7,
"TRACE": 8,
}
)
Enum value maps for HttpOperation_Method.
Dependency_State_name, Dependency_State_value
var (
Dependency_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "PROPOSED",
2: "VALIDATED",
}
Dependency_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"PROPOSED": 1,
"VALIDATED": 2,
}
)
Enum value maps for Dependency_State.
Dependency_DiscoveryMode_name, Dependency_DiscoveryMode_value
var (
Dependency_DiscoveryMode_name = map[int32]string{
0: "DISCOVERY_MODE_UNSPECIFIED",
1: "MANUAL",
}
Dependency_DiscoveryMode_value = map[string]int32{
"DISCOVERY_MODE_UNSPECIFIED": 0,
"MANUAL": 1,
}
)
Enum value maps for Dependency_DiscoveryMode.
DependencyErrorDetail_Error_name, DependencyErrorDetail_Error_value
var (
DependencyErrorDetail_Error_name = map[int32]string{
0: "ERROR_UNSPECIFIED",
1: "SUPPLIER_NOT_FOUND",
2: "SUPPLIER_RECREATED",
}
DependencyErrorDetail_Error_value = map[string]int32{
"ERROR_UNSPECIFIED": 0,
"SUPPLIER_NOT_FOUND": 1,
"SUPPLIER_RECREATED": 2,
}
)
Enum value maps for DependencyErrorDetail_Error.
ApiHubInstance_State_name, ApiHubInstance_State_value
var (
ApiHubInstance_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "INACTIVE",
2: "CREATING",
3: "ACTIVE",
4: "UPDATING",
5: "DELETING",
6: "FAILED",
}
ApiHubInstance_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"INACTIVE": 1,
"CREATING": 2,
"ACTIVE": 3,
"UPDATING": 4,
"DELETING": 5,
"FAILED": 6,
}
)
Enum value maps for ApiHubInstance_State.
Plugin_State_name, Plugin_State_value
var (
Plugin_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
Plugin_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)
Enum value maps for Plugin_State.
File_google_cloud_apihub_v1_apihub_service_proto
var File_google_cloud_apihub_v1_apihub_service_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_common_fields_proto
var File_google_cloud_apihub_v1_common_fields_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_host_project_registration_service_proto
var File_google_cloud_apihub_v1_host_project_registration_service_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_linting_service_proto
var File_google_cloud_apihub_v1_linting_service_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_plugin_service_proto
var File_google_cloud_apihub_v1_plugin_service_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_provisioning_service_proto
var File_google_cloud_apihub_v1_provisioning_service_proto protoreflect.FileDescriptor
File_google_cloud_apihub_v1_runtime_project_attachment_service_proto
var File_google_cloud_apihub_v1_runtime_project_attachment_service_proto protoreflect.FileDescriptor
Functions
func RegisterApiHubDependenciesServer
func RegisterApiHubDependenciesServer(s *grpc.Server, srv ApiHubDependenciesServer)
func RegisterApiHubPluginServer
func RegisterApiHubPluginServer(s *grpc.Server, srv ApiHubPluginServer)
func RegisterApiHubServer
func RegisterApiHubServer(s *grpc.Server, srv ApiHubServer)
func RegisterHostProjectRegistrationServiceServer
func RegisterHostProjectRegistrationServiceServer(s *grpc.Server, srv HostProjectRegistrationServiceServer)
func RegisterLintingServiceServer
func RegisterLintingServiceServer(s *grpc.Server, srv LintingServiceServer)
func RegisterProvisioningServer
func RegisterProvisioningServer(s *grpc.Server, srv ProvisioningServer)
func RegisterRuntimeProjectAttachmentServiceServer
func RegisterRuntimeProjectAttachmentServiceServer(s *grpc.Server, srv RuntimeProjectAttachmentServiceServer)
Api
type Api struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Documentation *Documentation `protobuf:"bytes,4,opt,name=documentation,proto3" json:"documentation,omitempty"`
Owner *Owner `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
Versions []string `protobuf:"bytes,6,rep,name=versions,proto3" json:"versions,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
TargetUser *AttributeValues `protobuf:"bytes,9,opt,name=target_user,json=targetUser,proto3" json:"target_user,omitempty"`
Team *AttributeValues `protobuf:"bytes,10,opt,name=team,proto3" json:"team,omitempty"`
BusinessUnit *AttributeValues `protobuf:"bytes,11,opt,name=business_unit,json=businessUnit,proto3" json:"business_unit,omitempty"`
MaturityLevel *AttributeValues `protobuf:"bytes,12,opt,name=maturity_level,json=maturityLevel,proto3" json:"maturity_level,omitempty"`
Attributes map[string]*AttributeValues "" /* 162 byte string literal not displayed */
ApiStyle *AttributeValues `protobuf:"bytes,14,opt,name=api_style,json=apiStyle,proto3" json:"api_style,omitempty"`
SelectedVersion string `protobuf:"bytes,15,opt,name=selected_version,json=selectedVersion,proto3" json:"selected_version,omitempty"`
}
An API resource in the API Hub.
func (*Api) Descriptor
Deprecated: Use Api.ProtoReflect.Descriptor instead.
func (*Api) GetApiStyle
func (x *Api) GetApiStyle() *AttributeValues
func (*Api) GetAttributes
func (x *Api) GetAttributes() map[string]*AttributeValues
func (*Api) GetBusinessUnit
func (x *Api) GetBusinessUnit() *AttributeValues
func (*Api) GetCreateTime
func (x *Api) GetCreateTime() *timestamppb.Timestamp
func (*Api) GetDescription
func (*Api) GetDisplayName
func (*Api) GetDocumentation
func (x *Api) GetDocumentation() *Documentation
func (*Api) GetMaturityLevel
func (x *Api) GetMaturityLevel() *AttributeValues
func (*Api) GetName
func (*Api) GetOwner
func (*Api) GetSelectedVersion
func (*Api) GetTargetUser
func (x *Api) GetTargetUser() *AttributeValues
func (*Api) GetTeam
func (x *Api) GetTeam() *AttributeValues
func (*Api) GetUpdateTime
func (x *Api) GetUpdateTime() *timestamppb.Timestamp
func (*Api) GetVersions
func (*Api) ProtoMessage
func (*Api) ProtoMessage()
func (*Api) ProtoReflect
func (x *Api) ProtoReflect() protoreflect.Message
func (*Api) Reset
func (x *Api) Reset()
func (*Api) String
ApiHubClient
type ApiHubClient interface {
// Create an API resource in the API hub.
// Once an API resource is created, versions can be added to it.
CreateApi(ctx context.Context, in *CreateApiRequest, opts ...grpc.CallOption) (*Api, error)
// Get API resource details including the API versions contained in it.
GetApi(ctx context.Context, in *GetApiRequest, opts ...grpc.CallOption) (*Api, error)
// List API resources in the API hub.
ListApis(ctx context.Context, in *ListApisRequest, opts ...grpc.CallOption) (*ListApisResponse, error)
// Update an API resource in the API hub. The following fields in the
// [API][] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Api.display_name]
// * [description][google.cloud.apihub.v1.Api.description]
// * [owner][google.cloud.apihub.v1.Api.owner]
// * [documentation][google.cloud.apihub.v1.Api.documentation]
// * [target_user][google.cloud.apihub.v1.Api.target_user]
// * [team][google.cloud.apihub.v1.Api.team]
// * [business_unit][google.cloud.apihub.v1.Api.business_unit]
// * [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
// * [attributes][google.cloud.apihub.v1.Api.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateApiRequest.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.
UpdateApi(ctx context.Context, in *UpdateApiRequest, opts ...grpc.CallOption) (*Api, error)
// Delete an API resource in the API hub. API can only be deleted if all
// underlying versions are deleted.
DeleteApi(ctx context.Context, in *DeleteApiRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Create an API version for an API resource in the API hub.
CreateVersion(ctx context.Context, in *CreateVersionRequest, opts ...grpc.CallOption) (*Version, error)
// 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.
GetVersion(ctx context.Context, in *GetVersionRequest, opts ...grpc.CallOption) (*Version, error)
// List API versions of an API resource in the API hub.
ListVersions(ctx context.Context, in *ListVersionsRequest, opts ...grpc.CallOption) (*ListVersionsResponse, error)
// Update API version. The following fields in the
// [version][google.cloud.apihub.v1.Version] can be updated currently:
//
// * [display_name][google.cloud.apihub.v1.Version.display_name]
// * [description][google.cloud.apihub.v1.Version.description]
// * [documentation][google.cloud.apihub.v1.Version.documentation]
// * [deployments][google.cloud.apihub.v1.Version.deployments]
// * [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
// * [compliance][google.cloud.apihub.v1.Version.compliance]
// * [accreditation][google.cloud.apihub.v1.Version.accreditation]
// * [attributes][google.cloud.apihub.v1.Version.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask]
// should be used to specify the fields being updated.
UpdateVersion(ctx context.Context, in *UpdateVersionRequest, opts ...grpc.CallOption) (*Version, error)
// Delete an API version. Version can only be deleted if all underlying specs,
// operations, definitions and linked deployments are deleted.
DeleteVersion(ctx context.Context, in *DeleteVersionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// 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][google.cloud.apihub.v1.ApiHub.GetSpec] method.
// In order to access the raw contents for a particular spec, use the
// [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method.
// In order to access the operations parsed from the spec, use the
// [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations]
// method.
CreateSpec(ctx context.Context, in *CreateSpecRequest, opts ...grpc.CallOption) (*Spec, error)
// Get details about the information parsed from a spec.
// Note that this method does not return the raw spec contents.
// Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method
// to retrieve the same.
GetSpec(ctx context.Context, in *GetSpecRequest, opts ...grpc.CallOption) (*Spec, error)
// Get spec contents.
GetSpecContents(ctx context.Context, in *GetSpecContentsRequest, opts ...grpc.CallOption) (*SpecContents, error)
// List specs corresponding to a particular API resource.
ListSpecs(ctx context.Context, in *ListSpecsRequest, opts ...grpc.CallOption) (*ListSpecsResponse, error)
// Update spec. The following fields in the
// [spec][google.cloud.apihub.v1.Spec] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Spec.display_name]
// * [source_uri][google.cloud.apihub.v1.Spec.source_uri]
// * [lint_response][google.cloud.apihub.v1.Spec.lint_response]
// * [attributes][google.cloud.apihub.v1.Spec.attributes]
// * [contents][google.cloud.apihub.v1.Spec.contents]
// * [spec_type][google.cloud.apihub.v1.Spec.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][google.cloud.apihub.v1.UpdateSpecRequest.update_mask]
// should be used to specify the fields being updated.
UpdateSpec(ctx context.Context, in *UpdateSpecRequest, opts ...grpc.CallOption) (*Spec, error)
// Delete a spec.
// Deleting a spec will also delete the associated operations from the
// version.
DeleteSpec(ctx context.Context, in *DeleteSpecRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Get details about a particular operation in API version.
GetApiOperation(ctx context.Context, in *GetApiOperationRequest, opts ...grpc.CallOption) (*ApiOperation, error)
// List operations in an API version.
ListApiOperations(ctx context.Context, in *ListApiOperationsRequest, opts ...grpc.CallOption) (*ListApiOperationsResponse, error)
// Get details about a definition in an API version.
GetDefinition(ctx context.Context, in *GetDefinitionRequest, opts ...grpc.CallOption) (*Definition, error)
// Create a deployment resource in the API hub.
// Once a deployment resource is created, it can be associated with API
// versions.
CreateDeployment(ctx context.Context, in *CreateDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// Get details about a deployment and the API versions linked to it.
GetDeployment(ctx context.Context, in *GetDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// List deployment resources in the API hub.
ListDeployments(ctx context.Context, in *ListDeploymentsRequest, opts ...grpc.CallOption) (*ListDeploymentsResponse, error)
// Update a deployment resource in the API hub. The following fields in the
// [deployment resource][google.cloud.apihub.v1.Deployment] can be
// updated:
//
// * [display_name][google.cloud.apihub.v1.Deployment.display_name]
// * [description][google.cloud.apihub.v1.Deployment.description]
// * [documentation][google.cloud.apihub.v1.Deployment.documentation]
// * [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
// * [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
// * [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
// * [slo][google.cloud.apihub.v1.Deployment.slo]
// * [environment][google.cloud.apihub.v1.Deployment.environment]
// * [attributes][google.cloud.apihub.v1.Deployment.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask]
// should be used to specify the fields being updated.
UpdateDeployment(ctx context.Context, in *UpdateDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// Delete a deployment resource in the API hub.
DeleteDeployment(ctx context.Context, in *DeleteDeploymentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// 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][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
// Allowed values for the same can be updated via
// [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
CreateAttribute(ctx context.Context, in *CreateAttributeRequest, opts ...grpc.CallOption) (*Attribute, error)
// Get details about the attribute.
GetAttribute(ctx context.Context, in *GetAttributeRequest, opts ...grpc.CallOption) (*Attribute, error)
// Update the attribute. The following fields in the
// [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Attribute.display_name]
// The display name can be updated for user defined attributes only.
// * [description][google.cloud.apihub.v1.Attribute.description]
// The description can be updated for user defined attributes only.
// * [allowed_values][google.cloud.apihub.v1.Attribute.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][google.cloud.apihub.v1.Attribute.cardinality]
// The cardinality can be updated for user defined attributes only.
// Cardinality can only be increased during an update.
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask]
// should be used to specify the fields being updated.
UpdateAttribute(ctx context.Context, in *UpdateAttributeRequest, opts ...grpc.CallOption) (*Attribute, error)
// 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.
DeleteAttribute(ctx context.Context, in *DeleteAttributeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// List all attributes.
ListAttributes(ctx context.Context, in *ListAttributesRequest, opts ...grpc.CallOption) (*ListAttributesResponse, error)
// Search across API-Hub resources.
SearchResources(ctx context.Context, in *SearchResourcesRequest, opts ...grpc.CallOption) (*SearchResourcesResponse, error)
// Create an External API resource in the API hub.
CreateExternalApi(ctx context.Context, in *CreateExternalApiRequest, opts ...grpc.CallOption) (*ExternalApi, error)
// Get details about an External API resource in the API hub.
GetExternalApi(ctx context.Context, in *GetExternalApiRequest, opts ...grpc.CallOption) (*ExternalApi, error)
// Update an External API resource in the API hub. The following fields can be
// updated:
//
// * [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
// * [description][google.cloud.apihub.v1.ExternalApi.description]
// * [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
// * [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
// * [paths][google.cloud.apihub.v1.ExternalApi.paths]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask]
// should be used to specify the fields being updated.
UpdateExternalApi(ctx context.Context, in *UpdateExternalApiRequest, opts ...grpc.CallOption) (*ExternalApi, error)
// Delete an External API resource in the API hub.
DeleteExternalApi(ctx context.Context, in *DeleteExternalApiRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// List External API resources in the API hub.
ListExternalApis(ctx context.Context, in *ListExternalApisRequest, opts ...grpc.CallOption) (*ListExternalApisResponse, error)
}
ApiHubClient is the client API for ApiHub service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewApiHubClient
func NewApiHubClient(cc grpc.ClientConnInterface) ApiHubClient
ApiHubDependenciesClient
type ApiHubDependenciesClient interface {
// Create a dependency between two entities in the API hub.
CreateDependency(ctx context.Context, in *CreateDependencyRequest, opts ...grpc.CallOption) (*Dependency, error)
// Get details about a dependency resource in the API hub.
GetDependency(ctx context.Context, in *GetDependencyRequest, opts ...grpc.CallOption) (*Dependency, error)
// Update a dependency based on the
// [update_mask][google.cloud.apihub.v1.UpdateDependencyRequest.update_mask]
// provided in the request.
//
// The following fields in the [dependency][google.cloud.apihub.v1.Dependency]
// can be updated:
// * [description][google.cloud.apihub.v1.Dependency.description]
UpdateDependency(ctx context.Context, in *UpdateDependencyRequest, opts ...grpc.CallOption) (*Dependency, error)
// Delete the dependency resource.
DeleteDependency(ctx context.Context, in *DeleteDependencyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// List dependencies based on the provided filter and pagination parameters.
ListDependencies(ctx context.Context, in *ListDependenciesRequest, opts ...grpc.CallOption) (*ListDependenciesResponse, error)
}
ApiHubDependenciesClient is the client API for ApiHubDependencies service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewApiHubDependenciesClient
func NewApiHubDependenciesClient(cc grpc.ClientConnInterface) ApiHubDependenciesClient
ApiHubDependenciesServer
type ApiHubDependenciesServer interface {
// Create a dependency between two entities in the API hub.
CreateDependency(context.Context, *CreateDependencyRequest) (*Dependency, error)
// Get details about a dependency resource in the API hub.
GetDependency(context.Context, *GetDependencyRequest) (*Dependency, error)
// Update a dependency based on the
// [update_mask][google.cloud.apihub.v1.UpdateDependencyRequest.update_mask]
// provided in the request.
//
// The following fields in the [dependency][google.cloud.apihub.v1.Dependency]
// can be updated:
// * [description][google.cloud.apihub.v1.Dependency.description]
UpdateDependency(context.Context, *UpdateDependencyRequest) (*Dependency, error)
// Delete the dependency resource.
DeleteDependency(context.Context, *DeleteDependencyRequest) (*emptypb.Empty, error)
// List dependencies based on the provided filter and pagination parameters.
ListDependencies(context.Context, *ListDependenciesRequest) (*ListDependenciesResponse, error)
}
ApiHubDependenciesServer is the server API for ApiHubDependencies service.
ApiHubInstance
type ApiHubInstance struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
State ApiHubInstance_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.apihub.v1.ApiHubInstance_State" json:"state,omitempty"`
StateMessage string `protobuf:"bytes,5,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
Config *ApiHubInstance_Config `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
}
An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
func (*ApiHubInstance) Descriptor
func (*ApiHubInstance) Descriptor() ([]byte, []int)
Deprecated: Use ApiHubInstance.ProtoReflect.Descriptor instead.
func (*ApiHubInstance) GetConfig
func (x *ApiHubInstance) GetConfig() *ApiHubInstance_Config
func (*ApiHubInstance) GetCreateTime
func (x *ApiHubInstance) GetCreateTime() *timestamppb.Timestamp
func (*ApiHubInstance) GetDescription
func (x *ApiHubInstance) GetDescription() string
func (*ApiHubInstance) GetLabels
func (x *ApiHubInstance) GetLabels() map[string]string
func (*ApiHubInstance) GetName
func (x *ApiHubInstance) GetName() string
func (*ApiHubInstance) GetState
func (x *ApiHubInstance) GetState() ApiHubInstance_State
func (*ApiHubInstance) GetStateMessage
func (x *ApiHubInstance) GetStateMessage() string
func (*ApiHubInstance) GetUpdateTime
func (x *ApiHubInstance) GetUpdateTime() *timestamppb.Timestamp
func (*ApiHubInstance) ProtoMessage
func (*ApiHubInstance) ProtoMessage()
func (*ApiHubInstance) ProtoReflect
func (x *ApiHubInstance) ProtoReflect() protoreflect.Message
func (*ApiHubInstance) Reset
func (x *ApiHubInstance) Reset()
func (*ApiHubInstance) String
func (x *ApiHubInstance) String() string
ApiHubInstance_Config
type ApiHubInstance_Config struct {
// Required. The Customer Managed Encryption Key (CMEK) used for data
// encryption. The CMEK name should follow the format of
// `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
// where the location must match the instance location.
CmekKeyName string `protobuf:"bytes,1,opt,name=cmek_key_name,json=cmekKeyName,proto3" json:"cmek_key_name,omitempty"`
// contains filtered or unexported fields
}
Available configurations to provision an ApiHub Instance.
func (*ApiHubInstance_Config) Descriptor
func (*ApiHubInstance_Config) Descriptor() ([]byte, []int)
Deprecated: Use ApiHubInstance_Config.ProtoReflect.Descriptor instead.
func (*ApiHubInstance_Config) GetCmekKeyName
func (x *ApiHubInstance_Config) GetCmekKeyName() string
func (*ApiHubInstance_Config) ProtoMessage
func (*ApiHubInstance_Config) ProtoMessage()
func (*ApiHubInstance_Config) ProtoReflect
func (x *ApiHubInstance_Config) ProtoReflect() protoreflect.Message
func (*ApiHubInstance_Config) Reset
func (x *ApiHubInstance_Config) Reset()
func (*ApiHubInstance_Config) String
func (x *ApiHubInstance_Config) String() string
ApiHubInstance_State
type ApiHubInstance_State int32
State of the ApiHub Instance.
ApiHubInstance_STATE_UNSPECIFIED, ApiHubInstance_INACTIVE, ApiHubInstance_CREATING, ApiHubInstance_ACTIVE, ApiHubInstance_UPDATING, ApiHubInstance_DELETING, ApiHubInstance_FAILED
const (
// The default value. This value is used if the state is omitted.
ApiHubInstance_STATE_UNSPECIFIED ApiHubInstance_State = 0
// The ApiHub instance has not been initialized or has been deleted.
ApiHubInstance_INACTIVE ApiHubInstance_State = 1
// The ApiHub instance is being created.
ApiHubInstance_CREATING ApiHubInstance_State = 2
// The ApiHub instance has been created and is ready for use.
ApiHubInstance_ACTIVE ApiHubInstance_State = 3
// The ApiHub instance is being updated.
ApiHubInstance_UPDATING ApiHubInstance_State = 4
// The ApiHub instance is being deleted.
ApiHubInstance_DELETING ApiHubInstance_State = 5
// The ApiHub instance encountered an error during a state change.
ApiHubInstance_FAILED ApiHubInstance_State = 6
)
func (ApiHubInstance_State) Descriptor
func (ApiHubInstance_State) Descriptor() protoreflect.EnumDescriptor
func (ApiHubInstance_State) Enum
func (x ApiHubInstance_State) Enum() *ApiHubInstance_State
func (ApiHubInstance_State) EnumDescriptor
func (ApiHubInstance_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use ApiHubInstance_State.Descriptor instead.
func (ApiHubInstance_State) Number
func (x ApiHubInstance_State) Number() protoreflect.EnumNumber
func (ApiHubInstance_State) String
func (x ApiHubInstance_State) String() string
func (ApiHubInstance_State) Type
func (ApiHubInstance_State) Type() protoreflect.EnumType
ApiHubPluginClient
type ApiHubPluginClient interface {
// Get details about an API Hub plugin.
GetPlugin(ctx context.Context, in *GetPluginRequest, opts ...grpc.CallOption) (*Plugin, error)
// Enables a plugin.
// The `state` of the plugin after enabling is `ENABLED`
EnablePlugin(ctx context.Context, in *EnablePluginRequest, opts ...grpc.CallOption) (*Plugin, error)
// Disables a plugin.
// The `state` of the plugin after disabling is `DISABLED`
DisablePlugin(ctx context.Context, in *DisablePluginRequest, opts ...grpc.CallOption) (*Plugin, error)
}
ApiHubPluginClient is the client API for ApiHubPlugin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewApiHubPluginClient
func NewApiHubPluginClient(cc grpc.ClientConnInterface) ApiHubPluginClient
ApiHubPluginServer
type ApiHubPluginServer interface {
// Get details about an API Hub plugin.
GetPlugin(context.Context, *GetPluginRequest) (*Plugin, error)
// Enables a plugin.
// The `state` of the plugin after enabling is `ENABLED`
EnablePlugin(context.Context, *EnablePluginRequest) (*Plugin, error)
// Disables a plugin.
// The `state` of the plugin after disabling is `DISABLED`
DisablePlugin(context.Context, *DisablePluginRequest) (*Plugin, error)
}
ApiHubPluginServer is the server API for ApiHubPlugin service.
ApiHubResource
type ApiHubResource struct {
// Types that are assignable to Resource:
//
// *ApiHubResource_Api
// *ApiHubResource_Operation
// *ApiHubResource_Deployment
// *ApiHubResource_Spec
// *ApiHubResource_Definition
// *ApiHubResource_Version
Resource isApiHubResource_Resource `protobuf_oneof:"resource"`
// contains filtered or unexported fields
}
ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.
func (*ApiHubResource) Descriptor
func (*ApiHubResource) Descriptor() ([]byte, []int)
Deprecated: Use ApiHubResource.ProtoReflect.Descriptor instead.
func (*ApiHubResource) GetApi
func (x *ApiHubResource) GetApi() *Api
func (*ApiHubResource) GetDefinition
func (x *ApiHubResource) GetDefinition() *Definition
func (*ApiHubResource) GetDeployment
func (x *ApiHubResource) GetDeployment() *Deployment
func (*ApiHubResource) GetOperation
func (x *ApiHubResource) GetOperation() *ApiOperation
func (*ApiHubResource) GetResource
func (m *ApiHubResource) GetResource() isApiHubResource_Resource
func (*ApiHubResource) GetSpec
func (x *ApiHubResource) GetSpec() *Spec
func (*ApiHubResource) GetVersion
func (x *ApiHubResource) GetVersion() *Version
func (*ApiHubResource) ProtoMessage
func (*ApiHubResource) ProtoMessage()
func (*ApiHubResource) ProtoReflect
func (x *ApiHubResource) ProtoReflect() protoreflect.Message
func (*ApiHubResource) Reset
func (x *ApiHubResource) Reset()
func (*ApiHubResource) String
func (x *ApiHubResource) String() string
ApiHubResource_Api
type ApiHubResource_Api struct {
// This represents Api resource in search results. Only name, display_name,
// description and owner fields are populated in search results.
Api *Api `protobuf:"bytes,1,opt,name=api,proto3,oneof"`
}
ApiHubResource_Definition
type ApiHubResource_Definition struct {
// This represents Definition resource in search results.
// Only name field is populated in search results.
Definition *Definition `protobuf:"bytes,5,opt,name=definition,proto3,oneof"`
}
ApiHubResource_Deployment
type ApiHubResource_Deployment struct {
// This represents Deployment resource in search results. Only name,
// display_name and description fields are populated in search results.
Deployment *Deployment `protobuf:"bytes,3,opt,name=deployment,proto3,oneof"`
}
ApiHubResource_Operation
type ApiHubResource_Operation struct {
// This represents ApiOperation resource in search results. Only name,
// and description fields are populated in search results.
Operation *ApiOperation `protobuf:"bytes,2,opt,name=operation,proto3,oneof"`
}
ApiHubResource_Spec
type ApiHubResource_Spec struct {
// This represents Spec resource in search results. Only name,
// display_name and description fields are populated in search results.
Spec *Spec `protobuf:"bytes,4,opt,name=spec,proto3,oneof"`
}
ApiHubResource_Version
type ApiHubResource_Version struct {
// This represents Version resource in search results. Only name,
// display_name and description fields are populated in search results.
Version *Version `protobuf:"bytes,6,opt,name=version,proto3,oneof"`
}
ApiHubServer
type ApiHubServer interface {
// Create an API resource in the API hub.
// Once an API resource is created, versions can be added to it.
CreateApi(context.Context, *CreateApiRequest) (*Api, error)
// Get API resource details including the API versions contained in it.
GetApi(context.Context, *GetApiRequest) (*Api, error)
// List API resources in the API hub.
ListApis(context.Context, *ListApisRequest) (*ListApisResponse, error)
// Update an API resource in the API hub. The following fields in the
// [API][] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Api.display_name]
// * [description][google.cloud.apihub.v1.Api.description]
// * [owner][google.cloud.apihub.v1.Api.owner]
// * [documentation][google.cloud.apihub.v1.Api.documentation]
// * [target_user][google.cloud.apihub.v1.Api.target_user]
// * [team][google.cloud.apihub.v1.Api.team]
// * [business_unit][google.cloud.apihub.v1.Api.business_unit]
// * [maturity_level][google.cloud.apihub.v1.Api.maturity_level]
// * [attributes][google.cloud.apihub.v1.Api.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateApiRequest.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.
UpdateApi(context.Context, *UpdateApiRequest) (*Api, error)
// Delete an API resource in the API hub. API can only be deleted if all
// underlying versions are deleted.
DeleteApi(context.Context, *DeleteApiRequest) (*emptypb.Empty, error)
// Create an API version for an API resource in the API hub.
CreateVersion(context.Context, *CreateVersionRequest) (*Version, error)
// 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.
GetVersion(context.Context, *GetVersionRequest) (*Version, error)
// List API versions of an API resource in the API hub.
ListVersions(context.Context, *ListVersionsRequest) (*ListVersionsResponse, error)
// Update API version. The following fields in the
// [version][google.cloud.apihub.v1.Version] can be updated currently:
//
// * [display_name][google.cloud.apihub.v1.Version.display_name]
// * [description][google.cloud.apihub.v1.Version.description]
// * [documentation][google.cloud.apihub.v1.Version.documentation]
// * [deployments][google.cloud.apihub.v1.Version.deployments]
// * [lifecycle][google.cloud.apihub.v1.Version.lifecycle]
// * [compliance][google.cloud.apihub.v1.Version.compliance]
// * [accreditation][google.cloud.apihub.v1.Version.accreditation]
// * [attributes][google.cloud.apihub.v1.Version.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask]
// should be used to specify the fields being updated.
UpdateVersion(context.Context, *UpdateVersionRequest) (*Version, error)
// Delete an API version. Version can only be deleted if all underlying specs,
// operations, definitions and linked deployments are deleted.
DeleteVersion(context.Context, *DeleteVersionRequest) (*emptypb.Empty, error)
// 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][google.cloud.apihub.v1.ApiHub.GetSpec] method.
// In order to access the raw contents for a particular spec, use the
// [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method.
// In order to access the operations parsed from the spec, use the
// [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations]
// method.
CreateSpec(context.Context, *CreateSpecRequest) (*Spec, error)
// Get details about the information parsed from a spec.
// Note that this method does not return the raw spec contents.
// Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method
// to retrieve the same.
GetSpec(context.Context, *GetSpecRequest) (*Spec, error)
// Get spec contents.
GetSpecContents(context.Context, *GetSpecContentsRequest) (*SpecContents, error)
// List specs corresponding to a particular API resource.
ListSpecs(context.Context, *ListSpecsRequest) (*ListSpecsResponse, error)
// Update spec. The following fields in the
// [spec][google.cloud.apihub.v1.Spec] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Spec.display_name]
// * [source_uri][google.cloud.apihub.v1.Spec.source_uri]
// * [lint_response][google.cloud.apihub.v1.Spec.lint_response]
// * [attributes][google.cloud.apihub.v1.Spec.attributes]
// * [contents][google.cloud.apihub.v1.Spec.contents]
// * [spec_type][google.cloud.apihub.v1.Spec.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][google.cloud.apihub.v1.UpdateSpecRequest.update_mask]
// should be used to specify the fields being updated.
UpdateSpec(context.Context, *UpdateSpecRequest) (*Spec, error)
// Delete a spec.
// Deleting a spec will also delete the associated operations from the
// version.
DeleteSpec(context.Context, *DeleteSpecRequest) (*emptypb.Empty, error)
// Get details about a particular operation in API version.
GetApiOperation(context.Context, *GetApiOperationRequest) (*ApiOperation, error)
// List operations in an API version.
ListApiOperations(context.Context, *ListApiOperationsRequest) (*ListApiOperationsResponse, error)
// Get details about a definition in an API version.
GetDefinition(context.Context, *GetDefinitionRequest) (*Definition, error)
// Create a deployment resource in the API hub.
// Once a deployment resource is created, it can be associated with API
// versions.
CreateDeployment(context.Context, *CreateDeploymentRequest) (*Deployment, error)
// Get details about a deployment and the API versions linked to it.
GetDeployment(context.Context, *GetDeploymentRequest) (*Deployment, error)
// List deployment resources in the API hub.
ListDeployments(context.Context, *ListDeploymentsRequest) (*ListDeploymentsResponse, error)
// Update a deployment resource in the API hub. The following fields in the
// [deployment resource][google.cloud.apihub.v1.Deployment] can be
// updated:
//
// * [display_name][google.cloud.apihub.v1.Deployment.display_name]
// * [description][google.cloud.apihub.v1.Deployment.description]
// * [documentation][google.cloud.apihub.v1.Deployment.documentation]
// * [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type]
// * [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri]
// * [endpoints][google.cloud.apihub.v1.Deployment.endpoints]
// * [slo][google.cloud.apihub.v1.Deployment.slo]
// * [environment][google.cloud.apihub.v1.Deployment.environment]
// * [attributes][google.cloud.apihub.v1.Deployment.attributes]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask]
// should be used to specify the fields being updated.
UpdateDeployment(context.Context, *UpdateDeploymentRequest) (*Deployment, error)
// Delete a deployment resource in the API hub.
DeleteDeployment(context.Context, *DeleteDeploymentRequest) (*emptypb.Empty, error)
// 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][google.cloud.apihub.v1.ApiHub.ListAttributes] method.
// Allowed values for the same can be updated via
// [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
CreateAttribute(context.Context, *CreateAttributeRequest) (*Attribute, error)
// Get details about the attribute.
GetAttribute(context.Context, *GetAttributeRequest) (*Attribute, error)
// Update the attribute. The following fields in the
// [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated:
//
// * [display_name][google.cloud.apihub.v1.Attribute.display_name]
// The display name can be updated for user defined attributes only.
// * [description][google.cloud.apihub.v1.Attribute.description]
// The description can be updated for user defined attributes only.
// * [allowed_values][google.cloud.apihub.v1.Attribute.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][google.cloud.apihub.v1.Attribute.cardinality]
// The cardinality can be updated for user defined attributes only.
// Cardinality can only be increased during an update.
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask]
// should be used to specify the fields being updated.
UpdateAttribute(context.Context, *UpdateAttributeRequest) (*Attribute, error)
// 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.
DeleteAttribute(context.Context, *DeleteAttributeRequest) (*emptypb.Empty, error)
// List all attributes.
ListAttributes(context.Context, *ListAttributesRequest) (*ListAttributesResponse, error)
// Search across API-Hub resources.
SearchResources(context.Context, *SearchResourcesRequest) (*SearchResourcesResponse, error)
// Create an External API resource in the API hub.
CreateExternalApi(context.Context, *CreateExternalApiRequest) (*ExternalApi, error)
// Get details about an External API resource in the API hub.
GetExternalApi(context.Context, *GetExternalApiRequest) (*ExternalApi, error)
// Update an External API resource in the API hub. The following fields can be
// updated:
//
// * [display_name][google.cloud.apihub.v1.ExternalApi.display_name]
// * [description][google.cloud.apihub.v1.ExternalApi.description]
// * [documentation][google.cloud.apihub.v1.ExternalApi.documentation]
// * [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints]
// * [paths][google.cloud.apihub.v1.ExternalApi.paths]
//
// The
// [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask]
// should be used to specify the fields being updated.
UpdateExternalApi(context.Context, *UpdateExternalApiRequest) (*ExternalApi, error)
// Delete an External API resource in the API hub.
DeleteExternalApi(context.Context, *DeleteExternalApiRequest) (*emptypb.Empty, error)
// List External API resources in the API hub.
ListExternalApis(context.Context, *ListExternalApisRequest) (*ListExternalApisResponse, error)
}
ApiHubServer is the server API for ApiHub service.
ApiOperation
type ApiOperation struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Spec string `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
Details *OperationDetails `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
Attributes map[string]*AttributeValues "" /* 161 byte string literal not displayed */
}
Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec.
func (*ApiOperation) Descriptor
func (*ApiOperation) Descriptor() ([]byte, []int)
Deprecated: Use ApiOperation.ProtoReflect.Descriptor instead.
func (*ApiOperation) GetAttributes
func (x *ApiOperation) GetAttributes() map[string]*AttributeValues
func (*ApiOperation) GetCreateTime
func (x *ApiOperation) GetCreateTime() *timestamppb.Timestamp
func (*ApiOperation) GetDetails
func (x *ApiOperation) GetDetails() *OperationDetails
func (*ApiOperation) GetName
func (x *ApiOperation) GetName() string
func (*ApiOperation) GetSpec
func (x *ApiOperation) GetSpec() string
func (*ApiOperation) GetUpdateTime
func (x *ApiOperation) GetUpdateTime() *timestamppb.Timestamp
func (*ApiOperation) ProtoMessage
func (*ApiOperation) ProtoMessage()
func (*ApiOperation) ProtoReflect
func (x *ApiOperation) ProtoReflect() protoreflect.Message
func (*ApiOperation) Reset
func (x *ApiOperation) Reset()
func (*ApiOperation) String
func (x *ApiOperation) String() string
Attribute
type Attribute struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
DefinitionType Attribute_DefinitionType "" /* 157 byte string literal not displayed */
Scope Attribute_Scope `protobuf:"varint,5,opt,name=scope,proto3,enum=google.cloud.apihub.v1.Attribute_Scope" json:"scope,omitempty"`
DataType Attribute_DataType "" /* 133 byte string literal not displayed */
AllowedValues []*Attribute_AllowedValue `protobuf:"bytes,7,rep,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
Cardinality int32 `protobuf:"varint,8,opt,name=cardinality,proto3" json:"cardinality,omitempty"`
Mandatory bool `protobuf:"varint,9,opt,name=mandatory,proto3" json:"mandatory,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
}
An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
func (*Attribute) Descriptor
Deprecated: Use Attribute.ProtoReflect.Descriptor instead.
func (*Attribute) GetAllowedValues
func (x *Attribute) GetAllowedValues() []*Attribute_AllowedValue
func (*Attribute) GetCardinality
func (*Attribute) GetCreateTime
func (x *Attribute) GetCreateTime() *timestamppb.Timestamp
func (*Attribute) GetDataType
func (x *Attribute) GetDataType() Attribute_DataType
func (*Attribute) GetDefinitionType
func (x *Attribute) GetDefinitionType() Attribute_DefinitionType
func (*Attribute) GetDescription
func (*Attribute) GetDisplayName
func (*Attribute) GetMandatory
func (*Attribute) GetName
func (*Attribute) GetScope
func (x *Attribute) GetScope() Attribute_Scope
func (*Attribute) GetUpdateTime
func (x *Attribute) GetUpdateTime() *timestamppb.Timestamp
func (*Attribute) ProtoMessage
func (*Attribute) ProtoMessage()
func (*Attribute) ProtoReflect
func (x *Attribute) ProtoReflect() protoreflect.Message
func (*Attribute) Reset
func (x *Attribute) Reset()
func (*Attribute) String
AttributeValues
type AttributeValues struct {
// The attribute values associated with the resource.
//
// Types that are assignable to Value:
//
// *AttributeValues_EnumValues
// *AttributeValues_StringValues
// *AttributeValues_JsonValues
Value isAttributeValues_Value `protobuf_oneof:"Value"`
// Output only. The name of the attribute.
// Format: projects/{project}/locations/{location}/attributes/{attribute}
Attribute string `protobuf:"bytes,1,opt,name=attribute,proto3" json:"attribute,omitempty"`
// contains filtered or unexported fields
}
The attribute values associated with resource.
func (*AttributeValues) Descriptor
func (*AttributeValues) Descriptor() ([]byte, []int)
Deprecated: Use AttributeValues.ProtoReflect.Descriptor instead.
func (*AttributeValues) GetAttribute
func (x *AttributeValues) GetAttribute() string
func (*AttributeValues) GetEnumValues
func (x *AttributeValues) GetEnumValues() *AttributeValues_EnumAttributeValues
func (*AttributeValues) GetJsonValues
func (x *AttributeValues) GetJsonValues() *AttributeValues_StringAttributeValues
func (*AttributeValues) GetStringValues
func (x *AttributeValues) GetStringValues() *AttributeValues_StringAttributeValues
func (*AttributeValues) GetValue
func (m *AttributeValues) GetValue() isAttributeValues_Value
func (*AttributeValues) ProtoMessage
func (*AttributeValues) ProtoMessage()
func (*AttributeValues) ProtoReflect
func (x *AttributeValues) ProtoReflect() protoreflect.Message
func (*AttributeValues) Reset
func (x *AttributeValues) Reset()
func (*AttributeValues) String
func (x *AttributeValues) String() string
AttributeValues_EnumAttributeValues
type AttributeValues_EnumAttributeValues struct {
// Required. The attribute values in case attribute data type is enum.
Values []*Attribute_AllowedValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
The attribute values of data type enum.
func (*AttributeValues_EnumAttributeValues) Descriptor
func (*AttributeValues_EnumAttributeValues) Descriptor() ([]byte, []int)
Deprecated: Use AttributeValues_EnumAttributeValues.ProtoReflect.Descriptor instead.
func (*AttributeValues_EnumAttributeValues) GetValues
func (x *AttributeValues_EnumAttributeValues) GetValues() []*Attribute_AllowedValue
func (*AttributeValues_EnumAttributeValues) ProtoMessage
func (*AttributeValues_EnumAttributeValues) ProtoMessage()
func (*AttributeValues_EnumAttributeValues) ProtoReflect
func (x *AttributeValues_EnumAttributeValues) ProtoReflect() protoreflect.Message
func (*AttributeValues_EnumAttributeValues) Reset
func (x *AttributeValues_EnumAttributeValues) Reset()
func (*AttributeValues_EnumAttributeValues) String
func (x *AttributeValues_EnumAttributeValues) String() string
AttributeValues_EnumValues
type AttributeValues_EnumValues struct {
// The attribute values associated with a resource in case attribute data
// type is enum.
EnumValues *AttributeValues_EnumAttributeValues `protobuf:"bytes,2,opt,name=enum_values,json=enumValues,proto3,oneof"`
}
AttributeValues_JsonValues
type AttributeValues_JsonValues struct {
// The attribute values associated with a resource in case attribute data
// type is JSON.
JsonValues *AttributeValues_StringAttributeValues `protobuf:"bytes,4,opt,name=json_values,json=jsonValues,proto3,oneof"`
}
AttributeValues_StringAttributeValues
type AttributeValues_StringAttributeValues struct {
// Required. The attribute values in case attribute data type is string or
// JSON.
Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
The attribute values of data type string or JSON.
func (*AttributeValues_StringAttributeValues) Descriptor
func (*AttributeValues_StringAttributeValues) Descriptor() ([]byte, []int)
Deprecated: Use AttributeValues_StringAttributeValues.ProtoReflect.Descriptor instead.
func (*AttributeValues_StringAttributeValues) GetValues
func (x *AttributeValues_StringAttributeValues) GetValues() []string
func (*AttributeValues_StringAttributeValues) ProtoMessage
func (*AttributeValues_StringAttributeValues) ProtoMessage()
func (*AttributeValues_StringAttributeValues) ProtoReflect
func (x *AttributeValues_StringAttributeValues) ProtoReflect() protoreflect.Message
func (*AttributeValues_StringAttributeValues) Reset
func (x *AttributeValues_StringAttributeValues) Reset()
func (*AttributeValues_StringAttributeValues) String
func (x *AttributeValues_StringAttributeValues) String() string
AttributeValues_StringValues
type AttributeValues_StringValues struct {
// The attribute values associated with a resource in case attribute data
// type is string.
StringValues *AttributeValues_StringAttributeValues `protobuf:"bytes,3,opt,name=string_values,json=stringValues,proto3,oneof"`
}
Attribute_AllowedValue
type Attribute_AllowedValue struct {
// Required. The ID of the allowed value.
// * If provided, the same will be used. The service will throw an error if
// the specified id is already used by another allowed value in the same
// attribute resource.
// * If not provided, a system generated id derived from the display name
// will be used. In this case, the service will handle conflict resolution
// by adding a system generated suffix in case of duplicates.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Required. The display name of the allowed value.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The detailed description of the allowed value.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. When set to true, the allowed value cannot be updated or
// deleted by the user. It can only be true for System defined attributes.
Immutable bool `protobuf:"varint,4,opt,name=immutable,proto3" json:"immutable,omitempty"`
// contains filtered or unexported fields
}
The value that can be assigned to the attribute when the data type is enum.
func (*Attribute_AllowedValue) Descriptor
func (*Attribute_AllowedValue) Descriptor() ([]byte, []int)
Deprecated: Use Attribute_AllowedValue.ProtoReflect.Descriptor instead.
func (*Attribute_AllowedValue) GetDescription
func (x *Attribute_AllowedValue) GetDescription() string
func (*Attribute_AllowedValue) GetDisplayName
func (x *Attribute_AllowedValue) GetDisplayName() string
func (*Attribute_AllowedValue) GetId
func (x *Attribute_AllowedValue) GetId() string
func (*Attribute_AllowedValue) GetImmutable
func (x *Attribute_AllowedValue) GetImmutable() bool
func (*Attribute_AllowedValue) ProtoMessage
func (*Attribute_AllowedValue) ProtoMessage()
func (*Attribute_AllowedValue) ProtoReflect
func (x *Attribute_AllowedValue) ProtoReflect() protoreflect.Message
func (*Attribute_AllowedValue) Reset
func (x *Attribute_AllowedValue) Reset()
func (*Attribute_AllowedValue) String
func (x *Attribute_AllowedValue) String() string
Attribute_DataType
type Attribute_DataType int32
Enumeration of attribute's data type.
Attribute_DATA_TYPE_UNSPECIFIED, Attribute_ENUM, Attribute_JSON, Attribute_STRING
const (
// Attribute data type unspecified.
Attribute_DATA_TYPE_UNSPECIFIED Attribute_DataType = 0
// Attribute's value is of type enum.
Attribute_ENUM Attribute_DataType = 1
// Attribute's value is of type json.
Attribute_JSON Attribute_DataType = 2
// Attribute's value is of type string.
Attribute_STRING Attribute_DataType = 3
)
func (Attribute_DataType) Descriptor
func (Attribute_DataType) Descriptor() protoreflect.EnumDescriptor
func (Attribute_DataType) Enum
func (x Attribute_DataType) Enum() *Attribute_DataType
func (Attribute_DataType) EnumDescriptor
func (Attribute_DataType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Attribute_DataType.Descriptor instead.
func (Attribute_DataType) Number
func (x Attribute_DataType) Number() protoreflect.EnumNumber
func (Attribute_DataType) String
func (x Attribute_DataType) String() string
func (Attribute_DataType) Type
func (Attribute_DataType) Type() protoreflect.EnumType
Attribute_DefinitionType
type Attribute_DefinitionType int32
Enumeration of attribute definition types.
Attribute_DEFINITION_TYPE_UNSPECIFIED, Attribute_SYSTEM_DEFINED, Attribute_USER_DEFINED
const (
// Attribute definition type unspecified.
Attribute_DEFINITION_TYPE_UNSPECIFIED Attribute_DefinitionType = 0
// The attribute is predefined by the API Hub. Note that only the list of
// allowed values can be updated in this case via UpdateAttribute method.
Attribute_SYSTEM_DEFINED Attribute_DefinitionType = 1
// The attribute is defined by the user.
Attribute_USER_DEFINED Attribute_DefinitionType = 2
)
func (Attribute_DefinitionType) Descriptor
func (Attribute_DefinitionType) Descriptor() protoreflect.EnumDescriptor
func (Attribute_DefinitionType) Enum
func (x Attribute_DefinitionType) Enum() *Attribute_DefinitionType
func (Attribute_DefinitionType) EnumDescriptor
func (Attribute_DefinitionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Attribute_DefinitionType.Descriptor instead.
func (Attribute_DefinitionType) Number
func (x Attribute_DefinitionType) Number() protoreflect.EnumNumber
func (Attribute_DefinitionType) String
func (x Attribute_DefinitionType) String() string
func (Attribute_DefinitionType) Type
func (Attribute_DefinitionType) Type() protoreflect.EnumType
Attribute_Scope
type Attribute_Scope int32
Enumeration for the scope of the attribute representing the resource in the API Hub to which the attribute can be linked.
Attribute_SCOPE_UNSPECIFIED, Attribute_API, Attribute_VERSION, Attribute_SPEC, Attribute_API_OPERATION, Attribute_DEPLOYMENT, Attribute_DEPENDENCY, Attribute_DEFINITION, Attribute_EXTERNAL_API, Attribute_PLUGIN
const (
// Scope Unspecified.
Attribute_SCOPE_UNSPECIFIED Attribute_Scope = 0
// Attribute can be linked to an API.
Attribute_API Attribute_Scope = 1
// Attribute can be linked to an API version.
Attribute_VERSION Attribute_Scope = 2
// Attribute can be linked to a Spec.
Attribute_SPEC Attribute_Scope = 3
// Attribute can be linked to an API Operation.
Attribute_API_OPERATION Attribute_Scope = 4
// Attribute can be linked to a Deployment.
Attribute_DEPLOYMENT Attribute_Scope = 5
// Attribute can be linked to a Dependency.
Attribute_DEPENDENCY Attribute_Scope = 6
// Attribute can be linked to a definition.
Attribute_DEFINITION Attribute_Scope = 7
// Attribute can be linked to a ExternalAPI.
Attribute_EXTERNAL_API Attribute_Scope = 8
// Attribute can be linked to a Plugin.
Attribute_PLUGIN Attribute_Scope = 9
)
func (Attribute_Scope) Descriptor
func (Attribute_Scope) Descriptor() protoreflect.EnumDescriptor
func (Attribute_Scope) Enum
func (x Attribute_Scope) Enum() *Attribute_Scope
func (Attribute_Scope) EnumDescriptor
func (Attribute_Scope) EnumDescriptor() ([]byte, []int)
Deprecated: Use Attribute_Scope.Descriptor instead.
func (Attribute_Scope) Number
func (x Attribute_Scope) Number() protoreflect.EnumNumber
func (Attribute_Scope) String
func (x Attribute_Scope) String() string
func (Attribute_Scope) Type
func (Attribute_Scope) Type() protoreflect.EnumType
CreateApiHubInstanceRequest
type CreateApiHubInstanceRequest struct {
// Required. The parent resource for the Api Hub instance resource.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_/`.
ApiHubInstanceId string `protobuf:"bytes,2,opt,name=api_hub_instance_id,json=apiHubInstanceId,proto3" json:"api_hub_instance_id,omitempty"`
// Required. The ApiHub instance.
ApiHubInstance *ApiHubInstance `protobuf:"bytes,3,opt,name=api_hub_instance,json=apiHubInstance,proto3" json:"api_hub_instance,omitempty"`
// contains filtered or unexported fields
}
The [CreateApiHubInstance][google.cloud.apihub.v1.Provisioning.CreateApiHubInstance] method's request.
func (*CreateApiHubInstanceRequest) Descriptor
func (*CreateApiHubInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateApiHubInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateApiHubInstanceRequest) GetApiHubInstance
func (x *CreateApiHubInstanceRequest) GetApiHubInstance() *ApiHubInstance
func (*CreateApiHubInstanceRequest) GetApiHubInstanceId
func (x *CreateApiHubInstanceRequest) GetApiHubInstanceId() string
func (*CreateApiHubInstanceRequest) GetParent
func (x *CreateApiHubInstanceRequest) GetParent() string
func (*CreateApiHubInstanceRequest) ProtoMessage
func (*CreateApiHubInstanceRequest) ProtoMessage()
func (*CreateApiHubInstanceRequest) ProtoReflect
func (x *CreateApiHubInstanceRequest) ProtoReflect() protoreflect.Message
func (*CreateApiHubInstanceRequest) Reset
func (x *CreateApiHubInstanceRequest) Reset()
func (*CreateApiHubInstanceRequest) String
func (x *CreateApiHubInstanceRequest) String() string
CreateApiRequest
type CreateApiRequest struct {
// Required. The parent resource for the API resource.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_/.
ApiId string `protobuf:"bytes,2,opt,name=api_id,json=apiId,proto3" json:"api_id,omitempty"`
// Required. The API resource to create.
Api *Api `protobuf:"bytes,3,opt,name=api,proto3" json:"api,omitempty"`
// contains filtered or unexported fields
}
The [CreateApi][google.cloud.apihub.v1.ApiHub.CreateApi] method's request.
func (*CreateApiRequest) Descriptor
func (*CreateApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateApiRequest.ProtoReflect.Descriptor instead.
func (*CreateApiRequest) GetApi
func (x *CreateApiRequest) GetApi() *Api
func (*CreateApiRequest) GetApiId
func (x *CreateApiRequest) GetApiId() string
func (*CreateApiRequest) GetParent
func (x *CreateApiRequest) GetParent() string
func (*CreateApiRequest) ProtoMessage
func (*CreateApiRequest) ProtoMessage()
func (*CreateApiRequest) ProtoReflect
func (x *CreateApiRequest) ProtoReflect() protoreflect.Message
func (*CreateApiRequest) Reset
func (x *CreateApiRequest) Reset()
func (*CreateApiRequest) String
func (x *CreateApiRequest) String() string
CreateAttributeRequest
type CreateAttributeRequest struct {
// Required. The parent resource for Attribute.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_/.
AttributeId string `protobuf:"bytes,2,opt,name=attribute_id,json=attributeId,proto3" json:"attribute_id,omitempty"`
// Required. The attribute to create.
Attribute *Attribute `protobuf:"bytes,3,opt,name=attribute,proto3" json:"attribute,omitempty"`
// contains filtered or unexported fields
}
The [CreateAttribute][google.cloud.apihub.v1.ApiHub.CreateAttribute] method's request.
func (*CreateAttributeRequest) Descriptor
func (*CreateAttributeRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAttributeRequest.ProtoReflect.Descriptor instead.
func (*CreateAttributeRequest) GetAttribute
func (x *CreateAttributeRequest) GetAttribute() *Attribute
func (*CreateAttributeRequest) GetAttributeId
func (x *CreateAttributeRequest) GetAttributeId() string
func (*CreateAttributeRequest) GetParent
func (x *CreateAttributeRequest) GetParent() string
func (*CreateAttributeRequest) ProtoMessage
func (*CreateAttributeRequest) ProtoMessage()
func (*CreateAttributeRequest) ProtoReflect
func (x *CreateAttributeRequest) ProtoReflect() protoreflect.Message
func (*CreateAttributeRequest) Reset
func (x *CreateAttributeRequest) Reset()
func (*CreateAttributeRequest) String
func (x *CreateAttributeRequest) String() string
CreateDependencyRequest
type CreateDependencyRequest struct {
// Required. The parent resource for the dependency resource.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_`.
DependencyId string `protobuf:"bytes,2,opt,name=dependency_id,json=dependencyId,proto3" json:"dependency_id,omitempty"`
// Required. The dependency resource to create.
Dependency *Dependency `protobuf:"bytes,3,opt,name=dependency,proto3" json:"dependency,omitempty"`
// contains filtered or unexported fields
}
The [CreateDependency][google.cloud.apihub.v1.ApiHubDependencies.CreateDependency] method's request.
func (*CreateDependencyRequest) Descriptor
func (*CreateDependencyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDependencyRequest.ProtoReflect.Descriptor instead.
func (*CreateDependencyRequest) GetDependency
func (x *CreateDependencyRequest) GetDependency() *Dependency
func (*CreateDependencyRequest) GetDependencyId
func (x *CreateDependencyRequest) GetDependencyId() string
func (*CreateDependencyRequest) GetParent
func (x *CreateDependencyRequest) GetParent() string
func (*CreateDependencyRequest) ProtoMessage
func (*CreateDependencyRequest) ProtoMessage()
func (*CreateDependencyRequest) ProtoReflect
func (x *CreateDependencyRequest) ProtoReflect() protoreflect.Message
func (*CreateDependencyRequest) Reset
func (x *CreateDependencyRequest) Reset()
func (*CreateDependencyRequest) String
func (x *CreateDependencyRequest) String() string
CreateDeploymentRequest
type CreateDeploymentRequest struct {
// Required. The parent resource for the deployment resource.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_/.
DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
// Required. The deployment resource to create.
Deployment *Deployment `protobuf:"bytes,3,opt,name=deployment,proto3" json:"deployment,omitempty"`
// contains filtered or unexported fields
}
The [CreateDeployment][google.cloud.apihub.v1.ApiHub.CreateDeployment] method's request.
func (*CreateDeploymentRequest) Descriptor
func (*CreateDeploymentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDeploymentRequest.ProtoReflect.Descriptor instead.
func (*CreateDeploymentRequest) GetDeployment
func (x *CreateDeploymentRequest) GetDeployment() *Deployment
func (*CreateDeploymentRequest) GetDeploymentId
func (x *CreateDeploymentRequest) GetDeploymentId() string
func (*CreateDeploymentRequest) GetParent
func (x *CreateDeploymentRequest) GetParent() string
func (*CreateDeploymentRequest) ProtoMessage
func (*CreateDeploymentRequest) ProtoMessage()
func (*CreateDeploymentRequest) ProtoReflect
func (x *CreateDeploymentRequest) ProtoReflect() protoreflect.Message
func (*CreateDeploymentRequest) Reset
func (x *CreateDeploymentRequest) Reset()
func (*CreateDeploymentRequest) String
func (x *CreateDeploymentRequest) String() string
CreateExternalApiRequest
type CreateExternalApiRequest struct {
// Required. The parent resource for the External API resource.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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][A-Z][0-9]-_/.
ExternalApiId string `protobuf:"bytes,2,opt,name=external_api_id,json=externalApiId,proto3" json:"external_api_id,omitempty"`
// Required. The External API resource to create.
ExternalApi *ExternalApi `protobuf:"bytes,3,opt,name=external_api,json=externalApi,proto3" json:"external_api,omitempty"`
// contains filtered or unexported fields
}
The [CreateExternalApi][google.cloud.apihub.v1.ApiHub.CreateExternalApi] method's request.
func (*CreateExternalApiRequest) Descriptor
func (*CreateExternalApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateExternalApiRequest.ProtoReflect.Descriptor instead.
func (*CreateExternalApiRequest) GetExternalApi
func (x *CreateExternalApiRequest) GetExternalApi() *ExternalApi
func (*CreateExternalApiRequest) GetExternalApiId
func (x *CreateExternalApiRequest) GetExternalApiId() string
func (*CreateExternalApiRequest) GetParent
func (x *CreateExternalApiRequest) GetParent() string
func (*CreateExternalApiRequest) ProtoMessage
func (*CreateExternalApiRequest) ProtoMessage()
func (*CreateExternalApiRequest) ProtoReflect
func (x *CreateExternalApiRequest) ProtoReflect() protoreflect.Message
func (*CreateExternalApiRequest) Reset
func (x *CreateExternalApiRequest) Reset()
func (*CreateExternalApiRequest) String
func (x *CreateExternalApiRequest) String() string
CreateHostProjectRegistrationRequest
type CreateHostProjectRegistrationRequest struct {
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
HostProjectRegistrationId string "" /* 140 byte string literal not displayed */
HostProjectRegistration *HostProjectRegistration "" /* 132 byte string literal not displayed */
}
The [CreateHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.CreateHostProjectRegistration] method's request.
func (*CreateHostProjectRegistrationRequest) Descriptor
func (*CreateHostProjectRegistrationRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateHostProjectRegistrationRequest.ProtoReflect.Descriptor instead.
func (*CreateHostProjectRegistrationRequest) GetHostProjectRegistration
func (x *CreateHostProjectRegistrationRequest) GetHostProjectRegistration() *HostProjectRegistration
func (*CreateHostProjectRegistrationRequest) GetHostProjectRegistrationId
func (x *CreateHostProjectRegistrationRequest) GetHostProjectRegistrationId() string
func (*CreateHostProjectRegistrationRequest) GetParent
func (x *CreateHostProjectRegistrationRequest) GetParent() string
func (*CreateHostProjectRegistrationRequest) ProtoMessage
func (*CreateHostProjectRegistrationRequest) ProtoMessage()
func (*CreateHostProjectRegistrationRequest) ProtoReflect
func (x *CreateHostProjectRegistrationRequest) ProtoReflect() protoreflect.Message
func (*CreateHostProjectRegistrationRequest) Reset
func (x *CreateHostProjectRegistrationRequest) Reset()
func (*CreateHostProjectRegistrationRequest) String
func (x *CreateHostProjectRegistrationRequest) String() string
CreateRuntimeProjectAttachmentRequest
type CreateRuntimeProjectAttachmentRequest struct {
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
RuntimeProjectAttachmentId string "" /* 143 byte string literal not displayed */
RuntimeProjectAttachment *RuntimeProjectAttachment "" /* 135 byte string literal not displayed */
}
The [CreateRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.CreateRuntimeProjectAttachment] method's request.
func (*CreateRuntimeProjectAttachmentRequest) Descriptor
func (*CreateRuntimeProjectAttachmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRuntimeProjectAttachmentRequest.ProtoReflect.Descriptor instead.
func (*CreateRuntimeProjectAttachmentRequest) GetParent
func (x *CreateRuntimeProjectAttachmentRequest) GetParent() string
func (*CreateRuntimeProjectAttachmentRequest) GetRuntimeProjectAttachment
func (x *CreateRuntimeProjectAttachmentRequest) GetRuntimeProjectAttachment() *RuntimeProjectAttachment
func (*CreateRuntimeProjectAttachmentRequest) GetRuntimeProjectAttachmentId
func (x *CreateRuntimeProjectAttachmentRequest) GetRuntimeProjectAttachmentId() string
func (*CreateRuntimeProjectAttachmentRequest) ProtoMessage
func (*CreateRuntimeProjectAttachmentRequest) ProtoMessage()
func (*CreateRuntimeProjectAttachmentRequest) ProtoReflect
func (x *CreateRuntimeProjectAttachmentRequest) ProtoReflect() protoreflect.Message
func (*CreateRuntimeProjectAttachmentRequest) Reset
func (x *CreateRuntimeProjectAttachmentRequest) Reset()
func (*CreateRuntimeProjectAttachmentRequest) String
func (x *CreateRuntimeProjectAttachmentRequest) String() string
CreateSpecRequest
type CreateSpecRequest struct {
// Required. The parent resource for Spec.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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, and valid characters
// are /[a-z][A-Z][0-9]-_/.
SpecId string `protobuf:"bytes,2,opt,name=spec_id,json=specId,proto3" json:"spec_id,omitempty"`
// Required. The spec to create.
Spec *Spec `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"`
// contains filtered or unexported fields
}
The [CreateSpec][google.cloud.apihub.v1.ApiHub.CreateSpec] method's request.
func (*CreateSpecRequest) Descriptor
func (*CreateSpecRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSpecRequest.ProtoReflect.Descriptor instead.
func (*CreateSpecRequest) GetParent
func (x *CreateSpecRequest) GetParent() string
func (*CreateSpecRequest) GetSpec
func (x *CreateSpecRequest) GetSpec() *Spec
func (*CreateSpecRequest) GetSpecId
func (x *CreateSpecRequest) GetSpecId() string
func (*CreateSpecRequest) ProtoMessage
func (*CreateSpecRequest) ProtoMessage()
func (*CreateSpecRequest) ProtoReflect
func (x *CreateSpecRequest) ProtoReflect() protoreflect.Message
func (*CreateSpecRequest) Reset
func (x *CreateSpecRequest) Reset()
func (*CreateSpecRequest) String
func (x *CreateSpecRequest) String() string
CreateVersionRequest
type CreateVersionRequest struct {
// Required. The parent resource for API version.
// Format: `projects/{project}/locations/{location}/apis/{api}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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, and valid characters
// are /[a-z][A-Z][0-9]-_/.
VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
// Required. The version to create.
Version *Version `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}
The [CreateVersion][google.cloud.apihub.v1.ApiHub.CreateVersion] method's request.
func (*CreateVersionRequest) Descriptor
func (*CreateVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateVersionRequest.ProtoReflect.Descriptor instead.
func (*CreateVersionRequest) GetParent
func (x *CreateVersionRequest) GetParent() string
func (*CreateVersionRequest) GetVersion
func (x *CreateVersionRequest) GetVersion() *Version
func (*CreateVersionRequest) GetVersionId
func (x *CreateVersionRequest) GetVersionId() string
func (*CreateVersionRequest) ProtoMessage
func (*CreateVersionRequest) ProtoMessage()
func (*CreateVersionRequest) ProtoReflect
func (x *CreateVersionRequest) ProtoReflect() protoreflect.Message
func (*CreateVersionRequest) Reset
func (x *CreateVersionRequest) Reset()
func (*CreateVersionRequest) String
func (x *CreateVersionRequest) String() string
Definition
type Definition struct {
Value isDefinition_Value `protobuf_oneof:"value"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Spec string `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
Type Definition_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.apihub.v1.Definition_Type" json:"type,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
Attributes map[string]*AttributeValues "" /* 161 byte string literal not displayed */
}
Represents a definition for example schema, request, response definitions
contained in an API version.
A definition is added/updated/deleted in an API version when a new spec is
added or an existing spec is updated/deleted in a version. Currently,
definition will be created only corresponding to OpenAPI spec as parsing is
supported for OpenAPI spec. Also, within OpenAPI spec, only schema
object
is supported.
func (*Definition) Descriptor
func (*Definition) Descriptor() ([]byte, []int)
Deprecated: Use Definition.ProtoReflect.Descriptor instead.
func (*Definition) GetAttributes
func (x *Definition) GetAttributes() map[string]*AttributeValues
func (*Definition) GetCreateTime
func (x *Definition) GetCreateTime() *timestamppb.Timestamp
func (*Definition) GetName
func (x *Definition) GetName() string
func (*Definition) GetSchema
func (x *Definition) GetSchema() *Schema
func (*Definition) GetSpec
func (x *Definition) GetSpec() string
func (*Definition) GetType
func (x *Definition) GetType() Definition_Type
func (*Definition) GetUpdateTime
func (x *Definition) GetUpdateTime() *timestamppb.Timestamp
func (*Definition) GetValue
func (m *Definition) GetValue() isDefinition_Value
func (*Definition) ProtoMessage
func (*Definition) ProtoMessage()
func (*Definition) ProtoReflect
func (x *Definition) ProtoReflect() protoreflect.Message
func (*Definition) Reset
func (x *Definition) Reset()
func (*Definition) String
func (x *Definition) String() string
Definition_Schema
type Definition_Schema struct {
// Output only. The value of a schema definition.
Schema *Schema `protobuf:"bytes,4,opt,name=schema,proto3,oneof"`
}
Definition_Type
type Definition_Type int32
Enumeration of definition types.
Definition_TYPE_UNSPECIFIED, Definition_SCHEMA
const (
// Definition type unspecified.
Definition_TYPE_UNSPECIFIED Definition_Type = 0
// Definition type schema.
Definition_SCHEMA Definition_Type = 1
)
func (Definition_Type) Descriptor
func (Definition_Type) Descriptor() protoreflect.EnumDescriptor
func (Definition_Type) Enum
func (x Definition_Type) Enum() *Definition_Type
func (Definition_Type) EnumDescriptor
func (Definition_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Definition_Type.Descriptor instead.
func (Definition_Type) Number
func (x Definition_Type) Number() protoreflect.EnumNumber
func (Definition_Type) String
func (x Definition_Type) String() string
func (Definition_Type) Type
func (Definition_Type) Type() protoreflect.EnumType
DeleteApiRequest
type DeleteApiRequest struct {
// Required. The name of the API resource to delete.
// Format: `projects/{project}/locations/{location}/apis/{api}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
The [DeleteApi][google.cloud.apihub.v1.ApiHub.DeleteApi] method's request.
func (*DeleteApiRequest) Descriptor
func (*DeleteApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteApiRequest.ProtoReflect.Descriptor instead.
func (*DeleteApiRequest) GetForce
func (x *DeleteApiRequest) GetForce() bool
func (*DeleteApiRequest) GetName
func (x *DeleteApiRequest) GetName() string
func (*DeleteApiRequest) ProtoMessage
func (*DeleteApiRequest) ProtoMessage()
func (*DeleteApiRequest) ProtoReflect
func (x *DeleteApiRequest) ProtoReflect() protoreflect.Message
func (*DeleteApiRequest) Reset
func (x *DeleteApiRequest) Reset()
func (*DeleteApiRequest) String
func (x *DeleteApiRequest) String() string
DeleteAttributeRequest
type DeleteAttributeRequest struct {
// Required. The name of the attribute to delete.
// Format:
// `projects/{project}/locations/{location}/attributes/{attribute}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteAttribute][google.cloud.apihub.v1.ApiHub.DeleteAttribute] method's request.
func (*DeleteAttributeRequest) Descriptor
func (*DeleteAttributeRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteAttributeRequest.ProtoReflect.Descriptor instead.
func (*DeleteAttributeRequest) GetName
func (x *DeleteAttributeRequest) GetName() string
func (*DeleteAttributeRequest) ProtoMessage
func (*DeleteAttributeRequest) ProtoMessage()
func (*DeleteAttributeRequest) ProtoReflect
func (x *DeleteAttributeRequest) ProtoReflect() protoreflect.Message
func (*DeleteAttributeRequest) Reset
func (x *DeleteAttributeRequest) Reset()
func (*DeleteAttributeRequest) String
func (x *DeleteAttributeRequest) String() string
DeleteDependencyRequest
type DeleteDependencyRequest struct {
// Required. The name of the dependency resource to delete.
// Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteDependency][google.cloud.apihub.v1.ApiHubDependencies.DeleteDependency] method's request.
func (*DeleteDependencyRequest) Descriptor
func (*DeleteDependencyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDependencyRequest.ProtoReflect.Descriptor instead.
func (*DeleteDependencyRequest) GetName
func (x *DeleteDependencyRequest) GetName() string
func (*DeleteDependencyRequest) ProtoMessage
func (*DeleteDependencyRequest) ProtoMessage()
func (*DeleteDependencyRequest) ProtoReflect
func (x *DeleteDependencyRequest) ProtoReflect() protoreflect.Message
func (*DeleteDependencyRequest) Reset
func (x *DeleteDependencyRequest) Reset()
func (*DeleteDependencyRequest) String
func (x *DeleteDependencyRequest) String() string
DeleteDeploymentRequest
type DeleteDeploymentRequest struct {
// Required. The name of the deployment resource to delete.
// Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteDeployment][google.cloud.apihub.v1.ApiHub.DeleteDeployment] method's request.
func (*DeleteDeploymentRequest) Descriptor
func (*DeleteDeploymentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDeploymentRequest.ProtoReflect.Descriptor instead.
func (*DeleteDeploymentRequest) GetName
func (x *DeleteDeploymentRequest) GetName() string
func (*DeleteDeploymentRequest) ProtoMessage
func (*DeleteDeploymentRequest) ProtoMessage()
func (*DeleteDeploymentRequest) ProtoReflect
func (x *DeleteDeploymentRequest) ProtoReflect() protoreflect.Message
func (*DeleteDeploymentRequest) Reset
func (x *DeleteDeploymentRequest) Reset()
func (*DeleteDeploymentRequest) String
func (x *DeleteDeploymentRequest) String() string
DeleteExternalApiRequest
type DeleteExternalApiRequest struct {
// Required. The name of the External API resource to delete.
// Format:
// `projects/{project}/locations/{location}/externalApis/{externalApi}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteExternalApi][google.cloud.apihub.v1.ApiHub.DeleteExternalApi] method's request.
func (*DeleteExternalApiRequest) Descriptor
func (*DeleteExternalApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteExternalApiRequest.ProtoReflect.Descriptor instead.
func (*DeleteExternalApiRequest) GetName
func (x *DeleteExternalApiRequest) GetName() string
func (*DeleteExternalApiRequest) ProtoMessage
func (*DeleteExternalApiRequest) ProtoMessage()
func (*DeleteExternalApiRequest) ProtoReflect
func (x *DeleteExternalApiRequest) ProtoReflect() protoreflect.Message
func (*DeleteExternalApiRequest) Reset
func (x *DeleteExternalApiRequest) Reset()
func (*DeleteExternalApiRequest) String
func (x *DeleteExternalApiRequest) String() string
DeleteRuntimeProjectAttachmentRequest
type DeleteRuntimeProjectAttachmentRequest struct {
// Required. The name of the Runtime Project Attachment to delete.
// Format:
// `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.DeleteRuntimeProjectAttachment] method's request.
func (*DeleteRuntimeProjectAttachmentRequest) Descriptor
func (*DeleteRuntimeProjectAttachmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRuntimeProjectAttachmentRequest.ProtoReflect.Descriptor instead.
func (*DeleteRuntimeProjectAttachmentRequest) GetName
func (x *DeleteRuntimeProjectAttachmentRequest) GetName() string
func (*DeleteRuntimeProjectAttachmentRequest) ProtoMessage
func (*DeleteRuntimeProjectAttachmentRequest) ProtoMessage()
func (*DeleteRuntimeProjectAttachmentRequest) ProtoReflect
func (x *DeleteRuntimeProjectAttachmentRequest) ProtoReflect() protoreflect.Message
func (*DeleteRuntimeProjectAttachmentRequest) Reset
func (x *DeleteRuntimeProjectAttachmentRequest) Reset()
func (*DeleteRuntimeProjectAttachmentRequest) String
func (x *DeleteRuntimeProjectAttachmentRequest) String() string
DeleteSpecRequest
type DeleteSpecRequest struct {
// Required. The name of the spec to delete.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DeleteSpec][google.cloud.apihub.v1.ApiHub.DeleteSpec] method's request.
func (*DeleteSpecRequest) Descriptor
func (*DeleteSpecRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSpecRequest.ProtoReflect.Descriptor instead.
func (*DeleteSpecRequest) GetName
func (x *DeleteSpecRequest) GetName() string
func (*DeleteSpecRequest) ProtoMessage
func (*DeleteSpecRequest) ProtoMessage()
func (*DeleteSpecRequest) ProtoReflect
func (x *DeleteSpecRequest) ProtoReflect() protoreflect.Message
func (*DeleteSpecRequest) Reset
func (x *DeleteSpecRequest) Reset()
func (*DeleteSpecRequest) String
func (x *DeleteSpecRequest) String() string
DeleteVersionRequest
type DeleteVersionRequest struct {
// Required. The name of the version to delete.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
The [DeleteVersion][google.cloud.apihub.v1.ApiHub.DeleteVersion] method's request.
func (*DeleteVersionRequest) Descriptor
func (*DeleteVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteVersionRequest.ProtoReflect.Descriptor instead.
func (*DeleteVersionRequest) GetForce
func (x *DeleteVersionRequest) GetForce() bool
func (*DeleteVersionRequest) GetName
func (x *DeleteVersionRequest) GetName() string
func (*DeleteVersionRequest) ProtoMessage
func (*DeleteVersionRequest) ProtoMessage()
func (*DeleteVersionRequest) ProtoReflect
func (x *DeleteVersionRequest) ProtoReflect() protoreflect.Message
func (*DeleteVersionRequest) Reset
func (x *DeleteVersionRequest) Reset()
func (*DeleteVersionRequest) String
func (x *DeleteVersionRequest) String() string
Dependency
type Dependency struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Consumer *DependencyEntityReference `protobuf:"bytes,2,opt,name=consumer,proto3" json:"consumer,omitempty"`
Supplier *DependencyEntityReference `protobuf:"bytes,3,opt,name=supplier,proto3" json:"supplier,omitempty"`
State Dependency_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.apihub.v1.Dependency_State" json:"state,omitempty"`
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
DiscoveryMode Dependency_DiscoveryMode "" /* 154 byte string literal not displayed */
ErrorDetail *DependencyErrorDetail `protobuf:"bytes,7,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
Attributes map[string]*AttributeValues "" /* 162 byte string literal not displayed */
}
A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two [Operations][google.cloud.apihub.v1.Operation] or between an [Operation][google.cloud.apihub.v1.Operation] and [External API][google.cloud.apihub.v1.ExternalApi].
func (*Dependency) Descriptor
func (*Dependency) Descriptor() ([]byte, []int)
Deprecated: Use Dependency.ProtoReflect.Descriptor instead.
func (*Dependency) GetAttributes
func (x *Dependency) GetAttributes() map[string]*AttributeValues
func (*Dependency) GetConsumer
func (x *Dependency) GetConsumer() *DependencyEntityReference
func (*Dependency) GetCreateTime
func (x *Dependency) GetCreateTime() *timestamppb.Timestamp
func (*Dependency) GetDescription
func (x *Dependency) GetDescription() string
func (*Dependency) GetDiscoveryMode
func (x *Dependency) GetDiscoveryMode() Dependency_DiscoveryMode
func (*Dependency) GetErrorDetail
func (x *Dependency) GetErrorDetail() *DependencyErrorDetail
func (*Dependency) GetName
func (x *Dependency) GetName() string
func (*Dependency) GetState
func (x *Dependency) GetState() Dependency_State
func (*Dependency) GetSupplier
func (x *Dependency) GetSupplier() *DependencyEntityReference
func (*Dependency) GetUpdateTime
func (x *Dependency) GetUpdateTime() *timestamppb.Timestamp
func (*Dependency) ProtoMessage
func (*Dependency) ProtoMessage()
func (*Dependency) ProtoReflect
func (x *Dependency) ProtoReflect() protoreflect.Message
func (*Dependency) Reset
func (x *Dependency) Reset()
func (*Dependency) String
func (x *Dependency) String() string
DependencyEntityReference
type DependencyEntityReference struct {
// Required. Unique identifier for the participating entity.
//
// Types that are assignable to Identifier:
//
// *DependencyEntityReference_OperationResourceName
// *DependencyEntityReference_ExternalApiResourceName
Identifier isDependencyEntityReference_Identifier `protobuf_oneof:"identifier"`
// Output only. Display name of the entity.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// contains filtered or unexported fields
}
Reference to an entity participating in a dependency.
func (*DependencyEntityReference) Descriptor
func (*DependencyEntityReference) Descriptor() ([]byte, []int)
Deprecated: Use DependencyEntityReference.ProtoReflect.Descriptor instead.
func (*DependencyEntityReference) GetDisplayName
func (x *DependencyEntityReference) GetDisplayName() string
func (*DependencyEntityReference) GetExternalApiResourceName
func (x *DependencyEntityReference) GetExternalApiResourceName() string
func (*DependencyEntityReference) GetIdentifier
func (m *DependencyEntityReference) GetIdentifier() isDependencyEntityReference_Identifier
func (*DependencyEntityReference) GetOperationResourceName
func (x *DependencyEntityReference) GetOperationResourceName() string
func (*DependencyEntityReference) ProtoMessage
func (*DependencyEntityReference) ProtoMessage()
func (*DependencyEntityReference) ProtoReflect
func (x *DependencyEntityReference) ProtoReflect() protoreflect.Message
func (*DependencyEntityReference) Reset
func (x *DependencyEntityReference) Reset()
func (*DependencyEntityReference) String
func (x *DependencyEntityReference) String() string
DependencyEntityReference_ExternalApiResourceName
type DependencyEntityReference_ExternalApiResourceName struct {
// The resource name of an external API in the API Hub.
//
// Format:
// `projects/{project}/locations/{location}/externalApis/{external_api}`
ExternalApiResourceName string `protobuf:"bytes,3,opt,name=external_api_resource_name,json=externalApiResourceName,proto3,oneof"`
}
DependencyEntityReference_OperationResourceName
type DependencyEntityReference_OperationResourceName struct {
// The resource name of an operation in the API Hub.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
OperationResourceName string `protobuf:"bytes,2,opt,name=operation_resource_name,json=operationResourceName,proto3,oneof"`
}
DependencyErrorDetail
type DependencyErrorDetail struct {
// Optional. Error in the dependency.
Error DependencyErrorDetail_Error `protobuf:"varint,1,opt,name=error,proto3,enum=google.cloud.apihub.v1.DependencyErrorDetail_Error" json:"error,omitempty"`
// Optional. Timestamp at which the error was found.
ErrorTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=error_time,json=errorTime,proto3" json:"error_time,omitempty"`
// contains filtered or unexported fields
}
Details describing error condition of a dependency.
func (*DependencyErrorDetail) Descriptor
func (*DependencyErrorDetail) Descriptor() ([]byte, []int)
Deprecated: Use DependencyErrorDetail.ProtoReflect.Descriptor instead.
func (*DependencyErrorDetail) GetError
func (x *DependencyErrorDetail) GetError() DependencyErrorDetail_Error
func (*DependencyErrorDetail) GetErrorTime
func (x *DependencyErrorDetail) GetErrorTime() *timestamppb.Timestamp
func (*DependencyErrorDetail) ProtoMessage
func (*DependencyErrorDetail) ProtoMessage()
func (*DependencyErrorDetail) ProtoReflect
func (x *DependencyErrorDetail) ProtoReflect() protoreflect.Message
func (*DependencyErrorDetail) Reset
func (x *DependencyErrorDetail) Reset()
func (*DependencyErrorDetail) String
func (x *DependencyErrorDetail) String() string
DependencyErrorDetail_Error
type DependencyErrorDetail_Error int32
Possible values representing an error in the dependency.
DependencyErrorDetail_ERROR_UNSPECIFIED, DependencyErrorDetail_SUPPLIER_NOT_FOUND, DependencyErrorDetail_SUPPLIER_RECREATED
const (
// Default value used for no error in the dependency.
DependencyErrorDetail_ERROR_UNSPECIFIED DependencyErrorDetail_Error = 0
// Supplier entity has been deleted.
DependencyErrorDetail_SUPPLIER_NOT_FOUND DependencyErrorDetail_Error = 1
// Supplier entity has been recreated.
DependencyErrorDetail_SUPPLIER_RECREATED DependencyErrorDetail_Error = 2
)
func (DependencyErrorDetail_Error) Descriptor
func (DependencyErrorDetail_Error) Descriptor() protoreflect.EnumDescriptor
func (DependencyErrorDetail_Error) Enum
func (x DependencyErrorDetail_Error) Enum() *DependencyErrorDetail_Error
func (DependencyErrorDetail_Error) EnumDescriptor
func (DependencyErrorDetail_Error) EnumDescriptor() ([]byte, []int)
Deprecated: Use DependencyErrorDetail_Error.Descriptor instead.
func (DependencyErrorDetail_Error) Number
func (x DependencyErrorDetail_Error) Number() protoreflect.EnumNumber
func (DependencyErrorDetail_Error) String
func (x DependencyErrorDetail_Error) String() string
func (DependencyErrorDetail_Error) Type
func (DependencyErrorDetail_Error) Type() protoreflect.EnumType
Dependency_DiscoveryMode
type Dependency_DiscoveryMode int32
Possible modes of discovering the dependency.
Dependency_DISCOVERY_MODE_UNSPECIFIED, Dependency_MANUAL
const (
// Default value. This value is unused.
Dependency_DISCOVERY_MODE_UNSPECIFIED Dependency_DiscoveryMode = 0
// Manual mode of discovery when the dependency is defined by the user.
Dependency_MANUAL Dependency_DiscoveryMode = 1
)
func (Dependency_DiscoveryMode) Descriptor
func (Dependency_DiscoveryMode) Descriptor() protoreflect.EnumDescriptor
func (Dependency_DiscoveryMode) Enum
func (x Dependency_DiscoveryMode) Enum() *Dependency_DiscoveryMode
func (Dependency_DiscoveryMode) EnumDescriptor
func (Dependency_DiscoveryMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use Dependency_DiscoveryMode.Descriptor instead.
func (Dependency_DiscoveryMode) Number
func (x Dependency_DiscoveryMode) Number() protoreflect.EnumNumber
func (Dependency_DiscoveryMode) String
func (x Dependency_DiscoveryMode) String() string
func (Dependency_DiscoveryMode) Type
func (Dependency_DiscoveryMode) Type() protoreflect.EnumType
Dependency_State
type Dependency_State int32
Possible states for a dependency.
Dependency_STATE_UNSPECIFIED, Dependency_PROPOSED, Dependency_VALIDATED
const (
// Default value. This value is unused.
Dependency_STATE_UNSPECIFIED Dependency_State = 0
// Dependency will be in a proposed state when it is newly identified by the
// API hub on its own.
Dependency_PROPOSED Dependency_State = 1
// Dependency will be in a validated state when it is validated by the
// admin or manually created in the API hub.
Dependency_VALIDATED Dependency_State = 2
)
func (Dependency_State) Descriptor
func (Dependency_State) Descriptor() protoreflect.EnumDescriptor
func (Dependency_State) Enum
func (x Dependency_State) Enum() *Dependency_State
func (Dependency_State) EnumDescriptor
func (Dependency_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Dependency_State.Descriptor instead.
func (Dependency_State) Number
func (x Dependency_State) Number() protoreflect.EnumNumber
func (Dependency_State) String
func (x Dependency_State) String() string
func (Dependency_State) Type
func (Dependency_State) Type() protoreflect.EnumType
Deployment
type Deployment struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Documentation *Documentation `protobuf:"bytes,4,opt,name=documentation,proto3" json:"documentation,omitempty"`
DeploymentType *AttributeValues `protobuf:"bytes,5,opt,name=deployment_type,json=deploymentType,proto3" json:"deployment_type,omitempty"`
ResourceUri string `protobuf:"bytes,6,opt,name=resource_uri,json=resourceUri,proto3" json:"resource_uri,omitempty"`
Endpoints []string `protobuf:"bytes,7,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
ApiVersions []string `protobuf:"bytes,8,rep,name=api_versions,json=apiVersions,proto3" json:"api_versions,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
Slo *AttributeValues `protobuf:"bytes,11,opt,name=slo,proto3" json:"slo,omitempty"`
Environment *AttributeValues `protobuf:"bytes,12,opt,name=environment,proto3" json:"environment,omitempty"`
Attributes map[string]*AttributeValues "" /* 162 byte string literal not displayed */
}
Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
func (*Deployment) Descriptor