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 {
// Identifier. The name of the API resource in the API Hub.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the API resource.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the API resource.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The documentation for the API resource.
Documentation *Documentation `protobuf:"bytes,4,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Optional. Owner details for the API resource.
Owner *Owner `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
// Output only. The list of versions present in an API resource.
// Note: An API resource can be associated with more than 1 version.
// Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Versions []string `protobuf:"bytes,6,rep,name=versions,proto3" json:"versions,omitempty"`
// Output only. The time at which the API resource was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the API resource was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The target users for the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-target-user`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
TargetUser *AttributeValues `protobuf:"bytes,9,opt,name=target_user,json=targetUser,proto3" json:"target_user,omitempty"`
// Optional. The team owning the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-team`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Team *AttributeValues `protobuf:"bytes,10,opt,name=team,proto3" json:"team,omitempty"`
// Optional. The business unit owning the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-business-unit`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
BusinessUnit *AttributeValues `protobuf:"bytes,11,opt,name=business_unit,json=businessUnit,proto3" json:"business_unit,omitempty"`
// Optional. The maturity level of the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-maturity-level`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
MaturityLevel *AttributeValues `protobuf:"bytes,12,opt,name=maturity_level,json=maturityLevel,proto3" json:"maturity_level,omitempty"`
// Optional. The list of user defined attributes associated with the API
// resource. The key is the attribute name. It will be of the format:
// `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,13,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The style of the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-api-style`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
ApiStyle *AttributeValues `protobuf:"bytes,14,opt,name=api_style,json=apiStyle,proto3" json:"api_style,omitempty"`
// Optional. The selected version for an API resource.
// This can be used when special handling is needed on client side for
// particular version of the API. Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
SelectedVersion string `protobuf:"bytes,15,opt,name=selected_version,json=selectedVersion,proto3" json:"selected_version,omitempty"`
// contains filtered or unexported fields
}
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 {
// Identifier. Format:
// `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Creation timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Last update timestamp.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The current state of the ApiHub instance.
State ApiHubInstance_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.apihub.v1.ApiHubInstance_State" json:"state,omitempty"`
// Output only. Extra information about ApiHub instance state. Currently the
// message would be populated when state is `FAILED`.
StateMessage string `protobuf:"bytes,5,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
// Required. Config of the ApiHub instance.
Config *ApiHubInstance_Config `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
// Optional. Instance labels to represent user-provided metadata.
// Refer to cloud documentation on labels for more details.
// https://cloud.google.com/compute/docs/labeling-resources
Labels map[string]string `protobuf:"bytes,7,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. Description of the ApiHub instance.
Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
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 {
// Identifier. The name of the operation.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The name of the spec from where the operation was parsed.
// Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Spec string `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
// Output only. Operation details.
Details *OperationDetails `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
// Output only. The time at which the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the operation was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The list of user defined attributes associated with the API
// operation resource. The key is the attribute name. It will be of the
// format: `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,6,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
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 {
// Identifier. The name of the attribute in the API Hub.
//
// Format:
// `projects/{project}/locations/{location}/attributes/{attribute}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the attribute.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the attribute.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The definition type of the attribute.
DefinitionType Attribute_DefinitionType `protobuf:"varint,4,opt,name=definition_type,json=definitionType,proto3,enum=google.cloud.apihub.v1.Attribute_DefinitionType" json:"definition_type,omitempty"`
// Required. The scope of the attribute. It represents the resource in the API
// Hub to which the attribute can be linked.
Scope Attribute_Scope `protobuf:"varint,5,opt,name=scope,proto3,enum=google.cloud.apihub.v1.Attribute_Scope" json:"scope,omitempty"`
// Required. The type of the data of the attribute.
DataType Attribute_DataType `protobuf:"varint,6,opt,name=data_type,json=dataType,proto3,enum=google.cloud.apihub.v1.Attribute_DataType" json:"data_type,omitempty"`
// Optional. The list of allowed values when the attribute value is of type
// enum. This is required when the data_type of the attribute is ENUM. The
// maximum number of allowed values of an attribute will be 1000.
AllowedValues []*Attribute_AllowedValue `protobuf:"bytes,7,rep,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
// Optional. The maximum number of values that the attribute can have when
// associated with an API Hub resource. Cardinality 1 would represent a
// single-valued attribute. It must not be less than 1 or greater than 20. If
// not specified, the cardinality would be set to 1 by default and represent a
// single-valued attribute.
Cardinality int32 `protobuf:"varint,8,opt,name=cardinality,proto3" json:"cardinality,omitempty"`
// Output only. When mandatory is true, the attribute is mandatory for the
// resource specified in the scope. Only System defined attributes can be
// mandatory.
Mandatory bool `protobuf:"varint,9,opt,name=mandatory,proto3" json:"mandatory,omitempty"`
// Output only. The time at which the attribute was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the attribute was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
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 {
// Required. The parent resource for the host project.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID to use for the Host Project Registration, which will
// become the final component of the host project registration's resource
// name. The ID must be the same as the Google cloud project specified in the
// host_project_registration.gcp_project field.
HostProjectRegistrationId string `protobuf:"bytes,2,opt,name=host_project_registration_id,json=hostProjectRegistrationId,proto3" json:"host_project_registration_id,omitempty"`
// Required. The host project registration to register.
HostProjectRegistration *HostProjectRegistration `protobuf:"bytes,3,opt,name=host_project_registration,json=hostProjectRegistration,proto3" json:"host_project_registration,omitempty"`
// contains filtered or unexported fields
}
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 {
// Required. The parent resource for the Runtime Project Attachment.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID to use for the Runtime Project Attachment, which will
// become the final component of the Runtime Project Attachment's name. The ID
// must be the same as the project ID of the Google cloud project specified in
// the runtime_project_attachment.runtime_project field.
RuntimeProjectAttachmentId string `protobuf:"bytes,2,opt,name=runtime_project_attachment_id,json=runtimeProjectAttachmentId,proto3" json:"runtime_project_attachment_id,omitempty"`
// Required. The Runtime Project Attachment to create.
RuntimeProjectAttachment *RuntimeProjectAttachment `protobuf:"bytes,3,opt,name=runtime_project_attachment,json=runtimeProjectAttachment,proto3" json:"runtime_project_attachment,omitempty"`
// contains filtered or unexported fields
}
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 {
// Types that are assignable to Value:
//
// *Definition_Schema
Value isDefinition_Value `protobuf_oneof:"value"`
// Identifier. The name of the definition.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The name of the spec from where the definition was parsed.
// Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Spec string `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
// Output only. The type of the definition.
Type Definition_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.apihub.v1.Definition_Type" json:"type,omitempty"`
// Output only. The time at which the definition was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the definition was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The list of user defined attributes associated with the
// definition resource. The key is the attribute name. It will be of the
// format: `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,7,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
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 {
// Identifier. The name of the dependency in the API Hub.
//
// Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. The entity acting as the consumer in the dependency.
Consumer *DependencyEntityReference `protobuf:"bytes,2,opt,name=consumer,proto3" json:"consumer,omitempty"`
// Required. Immutable. The entity acting as the supplier in the dependency.
Supplier *DependencyEntityReference `protobuf:"bytes,3,opt,name=supplier,proto3" json:"supplier,omitempty"`
// Output only. State of the dependency.
State Dependency_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.apihub.v1.Dependency_State" json:"state,omitempty"`
// Optional. Human readable description corresponding of the dependency.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Discovery mode of the dependency.
DiscoveryMode Dependency_DiscoveryMode `protobuf:"varint,6,opt,name=discovery_mode,json=discoveryMode,proto3,enum=google.cloud.apihub.v1.Dependency_DiscoveryMode" json:"discovery_mode,omitempty"`
// Output only. Error details of a dependency if the system has detected it
// internally.
ErrorDetail *DependencyErrorDetail `protobuf:"bytes,7,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"`
// Output only. The time at which the dependency was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the dependency was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The list of user defined attributes associated with the
// dependency resource. The key is the attribute name. It will be of the
// format: `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,10,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
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 {
// Identifier. The name of the deployment.
//
// Format:
// `projects/{project}/locations/{location}/deployments/{deployment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the deployment.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the deployment.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The documentation of the deployment.
Documentation *Documentation `protobuf:"bytes,4,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Required. The type of deployment.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-deployment-type`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
DeploymentType *AttributeValues `protobuf:"bytes,5,opt,name=deployment_type,json=deploymentType,proto3" json:"deployment_type,omitempty"`
// Required. A URI to the runtime resource. This URI can be used to manage the
// resource. For example, if the runtime resource is of type APIGEE_PROXY,
// then this field will contain the URI to the management UI of the proxy.
ResourceUri string `protobuf:"bytes,6,opt,name=resource_uri,json=resourceUri,proto3" json:"resource_uri,omitempty"`
// Required. The endpoints at which this deployment resource is listening for
// API requests. This could be a list of complete URIs, hostnames or an IP
// addresses.
Endpoints []string `protobuf:"bytes,7,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
// Output only. The API versions linked to this deployment.
// Note: A particular deployment could be linked to multiple different API
// versions (of same or different APIs).
ApiVersions []string `protobuf:"bytes,8,rep,name=api_versions,json=apiVersions,proto3" json:"api_versions,omitempty"`
// Output only. The time at which the deployment was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the deployment was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The SLO for this deployment.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-slo`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Slo *AttributeValues `protobuf:"bytes,11,opt,name=slo,proto3" json:"slo,omitempty"`
// Optional. The environment mapping to this deployment.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-environment`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Environment *AttributeValues `protobuf:"bytes,12,opt,name=environment,proto3" json:"environment,omitempty"`
// Optional. The list of user defined attributes associated with the
// deployment resource. The key is the attribute name. It will be of the
// format: `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,13,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
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
func (*Deployment) Descriptor() ([]byte, []int)
Deprecated: Use Deployment.ProtoReflect.Descriptor instead.
func (*Deployment) GetApiVersions
func (x *Deployment) GetApiVersions() []string
func (*Deployment) GetAttributes
func (x *Deployment) GetAttributes() map[string]*AttributeValues
func (*Deployment) GetCreateTime
func (x *Deployment) GetCreateTime() *timestamppb.Timestamp
func (*Deployment) GetDeploymentType
func (x *Deployment) GetDeploymentType() *AttributeValues
func (*Deployment) GetDescription
func (x *Deployment) GetDescription() string
func (*Deployment) GetDisplayName
func (x *Deployment) GetDisplayName() string
func (*Deployment) GetDocumentation
func (x *Deployment) GetDocumentation() *Documentation
func (*Deployment) GetEndpoints
func (x *Deployment) GetEndpoints() []string
func (*Deployment) GetEnvironment
func (x *Deployment) GetEnvironment() *AttributeValues
func (*Deployment) GetName
func (x *Deployment) GetName() string
func (*Deployment) GetResourceUri
func (x *Deployment) GetResourceUri() string
func (*Deployment) GetSlo
func (x *Deployment) GetSlo() *AttributeValues
func (*Deployment) GetUpdateTime
func (x *Deployment) GetUpdateTime() *timestamppb.Timestamp
func (*Deployment) ProtoMessage
func (*Deployment) ProtoMessage()
func (*Deployment) ProtoReflect
func (x *Deployment) ProtoReflect() protoreflect.Message
func (*Deployment) Reset
func (x *Deployment) Reset()
func (*Deployment) String
func (x *Deployment) String() string
DisablePluginRequest
type DisablePluginRequest struct {
// Required. The name of the plugin to disable.
// Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [DisablePlugin][google.cloud.apihub.v1.ApiHubPlugin.DisablePlugin] method's request.
func (*DisablePluginRequest) Descriptor
func (*DisablePluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use DisablePluginRequest.ProtoReflect.Descriptor instead.
func (*DisablePluginRequest) GetName
func (x *DisablePluginRequest) GetName() string
func (*DisablePluginRequest) ProtoMessage
func (*DisablePluginRequest) ProtoMessage()
func (*DisablePluginRequest) ProtoReflect
func (x *DisablePluginRequest) ProtoReflect() protoreflect.Message
func (*DisablePluginRequest) Reset
func (x *DisablePluginRequest) Reset()
func (*DisablePluginRequest) String
func (x *DisablePluginRequest) String() string
Documentation
type Documentation struct {
// Optional. The uri of the externally hosted documentation.
ExternalUri string `protobuf:"bytes,1,opt,name=external_uri,json=externalUri,proto3" json:"external_uri,omitempty"`
// contains filtered or unexported fields
}
Documentation details.
func (*Documentation) Descriptor
func (*Documentation) Descriptor() ([]byte, []int)
Deprecated: Use Documentation.ProtoReflect.Descriptor instead.
func (*Documentation) GetExternalUri
func (x *Documentation) GetExternalUri() string
func (*Documentation) ProtoMessage
func (*Documentation) ProtoMessage()
func (*Documentation) ProtoReflect
func (x *Documentation) ProtoReflect() protoreflect.Message
func (*Documentation) Reset
func (x *Documentation) Reset()
func (*Documentation) String
func (x *Documentation) String() string
EnablePluginRequest
type EnablePluginRequest struct {
// Required. The name of the plugin to enable.
// Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [EnablePlugin][google.cloud.apihub.v1.ApiHubPlugin.EnablePlugin] method's request.
func (*EnablePluginRequest) Descriptor
func (*EnablePluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use EnablePluginRequest.ProtoReflect.Descriptor instead.
func (*EnablePluginRequest) GetName
func (x *EnablePluginRequest) GetName() string
func (*EnablePluginRequest) ProtoMessage
func (*EnablePluginRequest) ProtoMessage()
func (*EnablePluginRequest) ProtoReflect
func (x *EnablePluginRequest) ProtoReflect() protoreflect.Message
func (*EnablePluginRequest) Reset
func (x *EnablePluginRequest) Reset()
func (*EnablePluginRequest) String
func (x *EnablePluginRequest) String() string
ExternalApi
type ExternalApi struct {
// Identifier. Format:
// `projects/{project}/locations/{location}/externalApi/{externalApi}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the external API. Max length is 63 characters
// (Unicode Code Points).
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Description of the external API. Max length is 2000 characters
// (Unicode Code Points).
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. List of endpoints on which this API is accessible.
Endpoints []string `protobuf:"bytes,4,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
// Optional. List of paths served by this API.
Paths []string `protobuf:"bytes,5,rep,name=paths,proto3" json:"paths,omitempty"`
// Optional. Documentation of the external API.
Documentation *Documentation `protobuf:"bytes,6,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Optional. The list of user defined attributes associated with the Version
// resource. The key is the attribute name. It will be of the format:
// `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,7,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. Creation timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Last update timestamp.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
func (*ExternalApi) Descriptor
func (*ExternalApi) Descriptor() ([]byte, []int)
Deprecated: Use ExternalApi.ProtoReflect.Descriptor instead.
func (*ExternalApi) GetAttributes
func (x *ExternalApi) GetAttributes() map[string]*AttributeValues
func (*ExternalApi) GetCreateTime
func (x *ExternalApi) GetCreateTime() *timestamppb.Timestamp
func (*ExternalApi) GetDescription
func (x *ExternalApi) GetDescription() string
func (*ExternalApi) GetDisplayName
func (x *ExternalApi) GetDisplayName() string
func (*ExternalApi) GetDocumentation
func (x *ExternalApi) GetDocumentation() *Documentation
func (*ExternalApi) GetEndpoints
func (x *ExternalApi) GetEndpoints() []string
func (*ExternalApi) GetName
func (x *ExternalApi) GetName() string
func (*ExternalApi) GetPaths
func (x *ExternalApi) GetPaths() []string
func (*ExternalApi) GetUpdateTime
func (x *ExternalApi) GetUpdateTime() *timestamppb.Timestamp
func (*ExternalApi) ProtoMessage
func (*ExternalApi) ProtoMessage()
func (*ExternalApi) ProtoReflect
func (x *ExternalApi) ProtoReflect() protoreflect.Message
func (*ExternalApi) Reset
func (x *ExternalApi) Reset()
func (*ExternalApi) String
func (x *ExternalApi) String() string
GetApiHubInstanceRequest
type GetApiHubInstanceRequest struct {
// Required. The name of the Api Hub instance to retrieve.
// Format:
// `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetApiHubInstance][google.cloud.apihub.v1.Provisioning.GetApiHubInstance] method's request.
func (*GetApiHubInstanceRequest) Descriptor
func (*GetApiHubInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetApiHubInstanceRequest.ProtoReflect.Descriptor instead.
func (*GetApiHubInstanceRequest) GetName
func (x *GetApiHubInstanceRequest) GetName() string
func (*GetApiHubInstanceRequest) ProtoMessage
func (*GetApiHubInstanceRequest) ProtoMessage()
func (*GetApiHubInstanceRequest) ProtoReflect
func (x *GetApiHubInstanceRequest) ProtoReflect() protoreflect.Message
func (*GetApiHubInstanceRequest) Reset
func (x *GetApiHubInstanceRequest) Reset()
func (*GetApiHubInstanceRequest) String
func (x *GetApiHubInstanceRequest) String() string
GetApiOperationRequest
type GetApiOperationRequest struct {
// Required. The name of the operation to retrieve.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetApiOperation][google.cloud.apihub.v1.ApiHub.GetApiOperation] method's request.
func (*GetApiOperationRequest) Descriptor
func (*GetApiOperationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetApiOperationRequest.ProtoReflect.Descriptor instead.
func (*GetApiOperationRequest) GetName
func (x *GetApiOperationRequest) GetName() string
func (*GetApiOperationRequest) ProtoMessage
func (*GetApiOperationRequest) ProtoMessage()
func (*GetApiOperationRequest) ProtoReflect
func (x *GetApiOperationRequest) ProtoReflect() protoreflect.Message
func (*GetApiOperationRequest) Reset
func (x *GetApiOperationRequest) Reset()
func (*GetApiOperationRequest) String
func (x *GetApiOperationRequest) String() string
GetApiRequest
type GetApiRequest struct {
// Required. The name of the API resource to retrieve.
// Format: `projects/{project}/locations/{location}/apis/{api}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetApi][google.cloud.apihub.v1.ApiHub.GetApi] method's request.
func (*GetApiRequest) Descriptor
func (*GetApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetApiRequest.ProtoReflect.Descriptor instead.
func (*GetApiRequest) GetName
func (x *GetApiRequest) GetName() string
func (*GetApiRequest) ProtoMessage
func (*GetApiRequest) ProtoMessage()
func (*GetApiRequest) ProtoReflect
func (x *GetApiRequest) ProtoReflect() protoreflect.Message
func (*GetApiRequest) Reset
func (x *GetApiRequest) Reset()
func (*GetApiRequest) String
func (x *GetApiRequest) String() string
GetAttributeRequest
type GetAttributeRequest struct {
// Required. The name of the attribute to retrieve.
// 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 [GetAttribute][google.cloud.apihub.v1.ApiHub.GetAttribute] method's request.
func (*GetAttributeRequest) Descriptor
func (*GetAttributeRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAttributeRequest.ProtoReflect.Descriptor instead.
func (*GetAttributeRequest) GetName
func (x *GetAttributeRequest) GetName() string
func (*GetAttributeRequest) ProtoMessage
func (*GetAttributeRequest) ProtoMessage()
func (*GetAttributeRequest) ProtoReflect
func (x *GetAttributeRequest) ProtoReflect() protoreflect.Message
func (*GetAttributeRequest) Reset
func (x *GetAttributeRequest) Reset()
func (*GetAttributeRequest) String
func (x *GetAttributeRequest) String() string
GetDefinitionRequest
type GetDefinitionRequest struct {
// Required. The name of the definition to retrieve.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetDefinition][google.cloud.apihub.v1.ApiHub.GetDefinition] method's request.
func (*GetDefinitionRequest) Descriptor
func (*GetDefinitionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDefinitionRequest.ProtoReflect.Descriptor instead.
func (*GetDefinitionRequest) GetName
func (x *GetDefinitionRequest) GetName() string
func (*GetDefinitionRequest) ProtoMessage
func (*GetDefinitionRequest) ProtoMessage()
func (*GetDefinitionRequest) ProtoReflect
func (x *GetDefinitionRequest) ProtoReflect() protoreflect.Message
func (*GetDefinitionRequest) Reset
func (x *GetDefinitionRequest) Reset()
func (*GetDefinitionRequest) String
func (x *GetDefinitionRequest) String() string
GetDependencyRequest
type GetDependencyRequest struct {
// Required. The name of the dependency resource to retrieve.
// 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 [GetDependency][.ApiHubDependencies.GetDependency] method's request.
func (*GetDependencyRequest) Descriptor
func (*GetDependencyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDependencyRequest.ProtoReflect.Descriptor instead.
func (*GetDependencyRequest) GetName
func (x *GetDependencyRequest) GetName() string
func (*GetDependencyRequest) ProtoMessage
func (*GetDependencyRequest) ProtoMessage()
func (*GetDependencyRequest) ProtoReflect
func (x *GetDependencyRequest) ProtoReflect() protoreflect.Message
func (*GetDependencyRequest) Reset
func (x *GetDependencyRequest) Reset()
func (*GetDependencyRequest) String
func (x *GetDependencyRequest) String() string
GetDeploymentRequest
type GetDeploymentRequest struct {
// Required. The name of the deployment resource to retrieve.
// 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 [GetDeployment][google.cloud.apihub.v1.ApiHub.GetDeployment] method's request.
func (*GetDeploymentRequest) Descriptor
func (*GetDeploymentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDeploymentRequest.ProtoReflect.Descriptor instead.
func (*GetDeploymentRequest) GetName
func (x *GetDeploymentRequest) GetName() string
func (*GetDeploymentRequest) ProtoMessage
func (*GetDeploymentRequest) ProtoMessage()
func (*GetDeploymentRequest) ProtoReflect
func (x *GetDeploymentRequest) ProtoReflect() protoreflect.Message
func (*GetDeploymentRequest) Reset
func (x *GetDeploymentRequest) Reset()
func (*GetDeploymentRequest) String
func (x *GetDeploymentRequest) String() string
GetExternalApiRequest
type GetExternalApiRequest struct {
// Required. The name of the External API resource to retrieve.
// 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 [GetExternalApi][google.cloud.apihub.v1.ApiHub.GetExternalApi] method's request.
func (*GetExternalApiRequest) Descriptor
func (*GetExternalApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetExternalApiRequest.ProtoReflect.Descriptor instead.
func (*GetExternalApiRequest) GetName
func (x *GetExternalApiRequest) GetName() string
func (*GetExternalApiRequest) ProtoMessage
func (*GetExternalApiRequest) ProtoMessage()
func (*GetExternalApiRequest) ProtoReflect
func (x *GetExternalApiRequest) ProtoReflect() protoreflect.Message
func (*GetExternalApiRequest) Reset
func (x *GetExternalApiRequest) Reset()
func (*GetExternalApiRequest) String
func (x *GetExternalApiRequest) String() string
GetHostProjectRegistrationRequest
type GetHostProjectRegistrationRequest struct {
// Required. Host project registration resource name.
// projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.GetHostProjectRegistration] method's request.
func (*GetHostProjectRegistrationRequest) Descriptor
func (*GetHostProjectRegistrationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetHostProjectRegistrationRequest.ProtoReflect.Descriptor instead.
func (*GetHostProjectRegistrationRequest) GetName
func (x *GetHostProjectRegistrationRequest) GetName() string
func (*GetHostProjectRegistrationRequest) ProtoMessage
func (*GetHostProjectRegistrationRequest) ProtoMessage()
func (*GetHostProjectRegistrationRequest) ProtoReflect
func (x *GetHostProjectRegistrationRequest) ProtoReflect() protoreflect.Message
func (*GetHostProjectRegistrationRequest) Reset
func (x *GetHostProjectRegistrationRequest) Reset()
func (*GetHostProjectRegistrationRequest) String
func (x *GetHostProjectRegistrationRequest) String() string
GetPluginRequest
type GetPluginRequest struct {
// Required. The name of the plugin to retrieve.
// Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetPlugin][google.cloud.apihub.v1.ApiHubPlugin.GetPlugin] method's request.
func (*GetPluginRequest) Descriptor
func (*GetPluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPluginRequest.ProtoReflect.Descriptor instead.
func (*GetPluginRequest) GetName
func (x *GetPluginRequest) GetName() string
func (*GetPluginRequest) ProtoMessage
func (*GetPluginRequest) ProtoMessage()
func (*GetPluginRequest) ProtoReflect
func (x *GetPluginRequest) ProtoReflect() protoreflect.Message
func (*GetPluginRequest) Reset
func (x *GetPluginRequest) Reset()
func (*GetPluginRequest) String
func (x *GetPluginRequest) String() string
GetRuntimeProjectAttachmentRequest
type GetRuntimeProjectAttachmentRequest struct {
// Required. The name of the API resource to retrieve.
// 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 [GetRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.GetRuntimeProjectAttachment] method's request.
func (*GetRuntimeProjectAttachmentRequest) Descriptor
func (*GetRuntimeProjectAttachmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRuntimeProjectAttachmentRequest.ProtoReflect.Descriptor instead.
func (*GetRuntimeProjectAttachmentRequest) GetName
func (x *GetRuntimeProjectAttachmentRequest) GetName() string
func (*GetRuntimeProjectAttachmentRequest) ProtoMessage
func (*GetRuntimeProjectAttachmentRequest) ProtoMessage()
func (*GetRuntimeProjectAttachmentRequest) ProtoReflect
func (x *GetRuntimeProjectAttachmentRequest) ProtoReflect() protoreflect.Message
func (*GetRuntimeProjectAttachmentRequest) Reset
func (x *GetRuntimeProjectAttachmentRequest) Reset()
func (*GetRuntimeProjectAttachmentRequest) String
func (x *GetRuntimeProjectAttachmentRequest) String() string
GetSpecContentsRequest
type GetSpecContentsRequest struct {
// Required. The name of the spec whose contents need to be retrieved.
// 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 [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method's request.
func (*GetSpecContentsRequest) Descriptor
func (*GetSpecContentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSpecContentsRequest.ProtoReflect.Descriptor instead.
func (*GetSpecContentsRequest) GetName
func (x *GetSpecContentsRequest) GetName() string
func (*GetSpecContentsRequest) ProtoMessage
func (*GetSpecContentsRequest) ProtoMessage()
func (*GetSpecContentsRequest) ProtoReflect
func (x *GetSpecContentsRequest) ProtoReflect() protoreflect.Message
func (*GetSpecContentsRequest) Reset
func (x *GetSpecContentsRequest) Reset()
func (*GetSpecContentsRequest) String
func (x *GetSpecContentsRequest) String() string
GetSpecRequest
type GetSpecRequest struct {
// Required. The name of the spec to retrieve.
// 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 [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method's request.
func (*GetSpecRequest) Descriptor
func (*GetSpecRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSpecRequest.ProtoReflect.Descriptor instead.
func (*GetSpecRequest) GetName
func (x *GetSpecRequest) GetName() string
func (*GetSpecRequest) ProtoMessage
func (*GetSpecRequest) ProtoMessage()
func (*GetSpecRequest) ProtoReflect
func (x *GetSpecRequest) ProtoReflect() protoreflect.Message
func (*GetSpecRequest) Reset
func (x *GetSpecRequest) Reset()
func (*GetSpecRequest) String
func (x *GetSpecRequest) String() string
GetStyleGuideContentsRequest
type GetStyleGuideContentsRequest struct {
// Required. The name of the StyleGuide whose contents need to be retrieved.
// There is exactly one style guide resource per project per location.
// The expected format is
// `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetStyleGuideContents][ApiHub.GetStyleGuideContents] method's request.
func (*GetStyleGuideContentsRequest) Descriptor
func (*GetStyleGuideContentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetStyleGuideContentsRequest.ProtoReflect.Descriptor instead.
func (*GetStyleGuideContentsRequest) GetName
func (x *GetStyleGuideContentsRequest) GetName() string
func (*GetStyleGuideContentsRequest) ProtoMessage
func (*GetStyleGuideContentsRequest) ProtoMessage()
func (*GetStyleGuideContentsRequest) ProtoReflect
func (x *GetStyleGuideContentsRequest) ProtoReflect() protoreflect.Message
func (*GetStyleGuideContentsRequest) Reset
func (x *GetStyleGuideContentsRequest) Reset()
func (*GetStyleGuideContentsRequest) String
func (x *GetStyleGuideContentsRequest) String() string
GetStyleGuideRequest
type GetStyleGuideRequest struct {
// Required. The name of the spec to retrieve.
// Format:
// `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetStyleGuide][ApiHub.GetStyleGuide] method's request.
func (*GetStyleGuideRequest) Descriptor
func (*GetStyleGuideRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetStyleGuideRequest.ProtoReflect.Descriptor instead.
func (*GetStyleGuideRequest) GetName
func (x *GetStyleGuideRequest) GetName() string
func (*GetStyleGuideRequest) ProtoMessage
func (*GetStyleGuideRequest) ProtoMessage()
func (*GetStyleGuideRequest) ProtoReflect
func (x *GetStyleGuideRequest) ProtoReflect() protoreflect.Message
func (*GetStyleGuideRequest) Reset
func (x *GetStyleGuideRequest) Reset()
func (*GetStyleGuideRequest) String
func (x *GetStyleGuideRequest) String() string
GetVersionRequest
type GetVersionRequest struct {
// Required. The name of the API version to retrieve.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [GetVersion][google.cloud.apihub.v1.ApiHub.GetVersion] method's request.
func (*GetVersionRequest) Descriptor
func (*GetVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetVersionRequest.ProtoReflect.Descriptor instead.
func (*GetVersionRequest) GetName
func (x *GetVersionRequest) GetName() string
func (*GetVersionRequest) ProtoMessage
func (*GetVersionRequest) ProtoMessage()
func (*GetVersionRequest) ProtoReflect
func (x *GetVersionRequest) ProtoReflect() protoreflect.Message
func (*GetVersionRequest) Reset
func (x *GetVersionRequest) Reset()
func (*GetVersionRequest) String
func (x *GetVersionRequest) String() string
HostProjectRegistration
type HostProjectRegistration struct {
// Identifier. The name of the host project registration.
// Format:
// "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Google cloud project name in the format:
// "projects/abc" or "projects/123". As input, project name with either
// project id or number are accepted. As output, this field will contain
// project number.
GcpProject string `protobuf:"bytes,2,opt,name=gcp_project,json=gcpProject,proto3" json:"gcp_project,omitempty"`
// Output only. The time at which the host project registration was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
func (*HostProjectRegistration) Descriptor
func (*HostProjectRegistration) Descriptor() ([]byte, []int)
Deprecated: Use HostProjectRegistration.ProtoReflect.Descriptor instead.
func (*HostProjectRegistration) GetCreateTime
func (x *HostProjectRegistration) GetCreateTime() *timestamppb.Timestamp
func (*HostProjectRegistration) GetGcpProject
func (x *HostProjectRegistration) GetGcpProject() string
func (*HostProjectRegistration) GetName
func (x *HostProjectRegistration) GetName() string
func (*HostProjectRegistration) ProtoMessage
func (*HostProjectRegistration) ProtoMessage()
func (*HostProjectRegistration) ProtoReflect
func (x *HostProjectRegistration) ProtoReflect() protoreflect.Message
func (*HostProjectRegistration) Reset
func (x *HostProjectRegistration) Reset()
func (*HostProjectRegistration) String
func (x *HostProjectRegistration) String() string
HostProjectRegistrationServiceClient
type HostProjectRegistrationServiceClient interface {
// Create a host project registration.
// A Google cloud project can be registered as a host project if it is not
// attached as a runtime project to another host project.
// A project can be registered as a host project only once. Subsequent
// register calls for the same project will fail.
CreateHostProjectRegistration(ctx context.Context, in *CreateHostProjectRegistrationRequest, opts ...grpc.CallOption) (*HostProjectRegistration, error)
// Get a host project registration.
GetHostProjectRegistration(ctx context.Context, in *GetHostProjectRegistrationRequest, opts ...grpc.CallOption) (*HostProjectRegistration, error)
// Lists host project registrations.
ListHostProjectRegistrations(ctx context.Context, in *ListHostProjectRegistrationsRequest, opts ...grpc.CallOption) (*ListHostProjectRegistrationsResponse, error)
}
HostProjectRegistrationServiceClient is the client API for HostProjectRegistrationService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewHostProjectRegistrationServiceClient
func NewHostProjectRegistrationServiceClient(cc grpc.ClientConnInterface) HostProjectRegistrationServiceClient
HostProjectRegistrationServiceServer
type HostProjectRegistrationServiceServer interface {
// Create a host project registration.
// A Google cloud project can be registered as a host project if it is not
// attached as a runtime project to another host project.
// A project can be registered as a host project only once. Subsequent
// register calls for the same project will fail.
CreateHostProjectRegistration(context.Context, *CreateHostProjectRegistrationRequest) (*HostProjectRegistration, error)
// Get a host project registration.
GetHostProjectRegistration(context.Context, *GetHostProjectRegistrationRequest) (*HostProjectRegistration, error)
// Lists host project registrations.
ListHostProjectRegistrations(context.Context, *ListHostProjectRegistrationsRequest) (*ListHostProjectRegistrationsResponse, error)
}
HostProjectRegistrationServiceServer is the server API for HostProjectRegistrationService service.
HttpOperation
type HttpOperation struct {
// Output only. The path details for the Operation.
Path *Path `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// Output only. Operation method
Method HttpOperation_Method `protobuf:"varint,2,opt,name=method,proto3,enum=google.cloud.apihub.v1.HttpOperation_Method" json:"method,omitempty"`
// contains filtered or unexported fields
}
The HTTP Operation.
func (*HttpOperation) Descriptor
func (*HttpOperation) Descriptor() ([]byte, []int)
Deprecated: Use HttpOperation.ProtoReflect.Descriptor instead.
func (*HttpOperation) GetMethod
func (x *HttpOperation) GetMethod() HttpOperation_Method
func (*HttpOperation) GetPath
func (x *HttpOperation) GetPath() *Path
func (*HttpOperation) ProtoMessage
func (*HttpOperation) ProtoMessage()
func (*HttpOperation) ProtoReflect
func (x *HttpOperation) ProtoReflect() protoreflect.Message
func (*HttpOperation) Reset
func (x *HttpOperation) Reset()
func (*HttpOperation) String
func (x *HttpOperation) String() string
HttpOperation_Method
type HttpOperation_Method int32
Enumeration of Method types.
HttpOperation_METHOD_UNSPECIFIED, HttpOperation_GET, HttpOperation_PUT, HttpOperation_POST, HttpOperation_DELETE, HttpOperation_OPTIONS, HttpOperation_HEAD, HttpOperation_PATCH, HttpOperation_TRACE
const (
// Method unspecified.
HttpOperation_METHOD_UNSPECIFIED HttpOperation_Method = 0
// Get Operation type.
HttpOperation_GET HttpOperation_Method = 1
// Put Operation type.
HttpOperation_PUT HttpOperation_Method = 2
// Post Operation type.
HttpOperation_POST HttpOperation_Method = 3
// Delete Operation type.
HttpOperation_DELETE HttpOperation_Method = 4
// Options Operation type.
HttpOperation_OPTIONS HttpOperation_Method = 5
// Head Operation type.
HttpOperation_HEAD HttpOperation_Method = 6
// Patch Operation type.
HttpOperation_PATCH HttpOperation_Method = 7
// Trace Operation type.
HttpOperation_TRACE HttpOperation_Method = 8
)
func (HttpOperation_Method) Descriptor
func (HttpOperation_Method) Descriptor() protoreflect.EnumDescriptor
func (HttpOperation_Method) Enum
func (x HttpOperation_Method) Enum() *HttpOperation_Method
func (HttpOperation_Method) EnumDescriptor
func (HttpOperation_Method) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpOperation_Method.Descriptor instead.
func (HttpOperation_Method) Number
func (x HttpOperation_Method) Number() protoreflect.EnumNumber
func (HttpOperation_Method) String
func (x HttpOperation_Method) String() string
func (HttpOperation_Method) Type
func (HttpOperation_Method) Type() protoreflect.EnumType
Issue
type Issue struct {
// Required. Rule code unique to each rule defined in linter.
Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
// Required. An array of strings indicating the location in the analyzed
// document where the rule was triggered.
Path []string `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"`
// Required. Human-readable message describing the issue found by the linter.
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
// Required. Severity level of the rule violation.
Severity Severity `protobuf:"varint,4,opt,name=severity,proto3,enum=google.cloud.apihub.v1.Severity" json:"severity,omitempty"`
// Required. Object describing where in the file the issue was found.
Range *Range `protobuf:"bytes,5,opt,name=range,proto3" json:"range,omitempty"`
// contains filtered or unexported fields
}
Issue contains the details of a single issue found by the linter.
func (*Issue) Descriptor
Deprecated: Use Issue.ProtoReflect.Descriptor instead.
func (*Issue) GetCode
func (*Issue) GetMessage
func (*Issue) GetPath
func (*Issue) GetRange
func (*Issue) GetSeverity
func (*Issue) ProtoMessage
func (*Issue) ProtoMessage()
func (*Issue) ProtoReflect
func (x *Issue) ProtoReflect() protoreflect.Message
func (*Issue) Reset
func (x *Issue) Reset()
func (*Issue) String
LintResponse
type LintResponse struct {
// Optional. Array of issues found in the analyzed document.
Issues []*Issue `protobuf:"bytes,1,rep,name=issues,proto3" json:"issues,omitempty"`
// Optional. Summary of all issue types and counts for each severity level.
Summary []*LintResponse_SummaryEntry `protobuf:"bytes,2,rep,name=summary,proto3" json:"summary,omitempty"`
// Required. Lint state represents success or failure for linting.
State LintState `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.apihub.v1.LintState" json:"state,omitempty"`
// Required. Name of the linting application.
Source string `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
// Required. Name of the linter used.
Linter Linter `protobuf:"varint,5,opt,name=linter,proto3,enum=google.cloud.apihub.v1.Linter" json:"linter,omitempty"`
// Required. Timestamp when the linting response was generated.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
LintResponse contains the response from the linter.
func (*LintResponse) Descriptor
func (*LintResponse) Descriptor() ([]byte, []int)
Deprecated: Use LintResponse.ProtoReflect.Descriptor instead.
func (*LintResponse) GetCreateTime
func (x *LintResponse) GetCreateTime() *timestamppb.Timestamp
func (*LintResponse) GetIssues
func (x *LintResponse) GetIssues() []*Issue
func (*LintResponse) GetLinter
func (x *LintResponse) GetLinter() Linter
func (*LintResponse) GetSource
func (x *LintResponse) GetSource() string
func (*LintResponse) GetState
func (x *LintResponse) GetState() LintState
func (*LintResponse) GetSummary
func (x *LintResponse) GetSummary() []*LintResponse_SummaryEntry
func (*LintResponse) ProtoMessage
func (*LintResponse) ProtoMessage()
func (*LintResponse) ProtoReflect
func (x *LintResponse) ProtoReflect() protoreflect.Message
func (*LintResponse) Reset
func (x *LintResponse) Reset()
func (*LintResponse) String
func (x *LintResponse) String() string
LintResponse_SummaryEntry
type LintResponse_SummaryEntry struct {
// Required. Severity of the issue.
Severity Severity `protobuf:"varint,1,opt,name=severity,proto3,enum=google.cloud.apihub.v1.Severity" json:"severity,omitempty"`
// Required. Count of issues with the given severity.
Count int32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
// contains filtered or unexported fields
}
Count of issues with a given severity.
func (*LintResponse_SummaryEntry) Descriptor
func (*LintResponse_SummaryEntry) Descriptor() ([]byte, []int)
Deprecated: Use LintResponse_SummaryEntry.ProtoReflect.Descriptor instead.
func (*LintResponse_SummaryEntry) GetCount
func (x *LintResponse_SummaryEntry) GetCount() int32
func (*LintResponse_SummaryEntry) GetSeverity
func (x *LintResponse_SummaryEntry) GetSeverity() Severity
func (*LintResponse_SummaryEntry) ProtoMessage
func (*LintResponse_SummaryEntry) ProtoMessage()
func (*LintResponse_SummaryEntry) ProtoReflect
func (x *LintResponse_SummaryEntry) ProtoReflect() protoreflect.Message
func (*LintResponse_SummaryEntry) Reset
func (x *LintResponse_SummaryEntry) Reset()
func (*LintResponse_SummaryEntry) String
func (x *LintResponse_SummaryEntry) String() string
LintSpecRequest
type LintSpecRequest struct {
// Required. The name of the spec to be linted.
// 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 [LintSpec][ApiHub.LintSpec] method's request.
func (*LintSpecRequest) Descriptor
func (*LintSpecRequest) Descriptor() ([]byte, []int)
Deprecated: Use LintSpecRequest.ProtoReflect.Descriptor instead.
func (*LintSpecRequest) GetName
func (x *LintSpecRequest) GetName() string
func (*LintSpecRequest) ProtoMessage
func (*LintSpecRequest) ProtoMessage()
func (*LintSpecRequest) ProtoReflect
func (x *LintSpecRequest) ProtoReflect() protoreflect.Message
func (*LintSpecRequest) Reset
func (x *LintSpecRequest) Reset()
func (*LintSpecRequest) String
func (x *LintSpecRequest) String() string
LintState
type LintState int32
Lint state represents success or failure for linting.
LintState_LINT_STATE_UNSPECIFIED, LintState_LINT_STATE_SUCCESS, LintState_LINT_STATE_ERROR
const (
// Lint state unspecified.
LintState_LINT_STATE_UNSPECIFIED LintState = 0
// Linting was completed successfully.
LintState_LINT_STATE_SUCCESS LintState = 1
// Linting encountered errors.
LintState_LINT_STATE_ERROR LintState = 2
)
func (LintState) Descriptor
func (LintState) Descriptor() protoreflect.EnumDescriptor
func (LintState) Enum
func (LintState) EnumDescriptor
Deprecated: Use LintState.Descriptor instead.
func (LintState) Number
func (x LintState) Number() protoreflect.EnumNumber
func (LintState) String
func (LintState) Type
func (LintState) Type() protoreflect.EnumType
Linter
type Linter int32
Enumeration of linter types.
Linter_LINTER_UNSPECIFIED, Linter_SPECTRAL, Linter_OTHER
const (
// Linter type unspecified.
Linter_LINTER_UNSPECIFIED Linter = 0
// Linter type spectral.
Linter_SPECTRAL Linter = 1
// Linter type other.
Linter_OTHER Linter = 2
)
func (Linter) Descriptor
func (Linter) Descriptor() protoreflect.EnumDescriptor
func (Linter) Enum
func (Linter) EnumDescriptor
Deprecated: Use Linter.Descriptor instead.
func (Linter) Number
func (x Linter) Number() protoreflect.EnumNumber
func (Linter) String
func (Linter) Type
func (Linter) Type() protoreflect.EnumType
LintingServiceClient
type LintingServiceClient interface {
// Get the style guide being used for linting.
GetStyleGuide(ctx context.Context, in *GetStyleGuideRequest, opts ...grpc.CallOption) (*StyleGuide, error)
// Update the styleGuide to be used for liniting in by API hub.
UpdateStyleGuide(ctx context.Context, in *UpdateStyleGuideRequest, opts ...grpc.CallOption) (*StyleGuide, error)
// Get the contents of the style guide.
GetStyleGuideContents(ctx context.Context, in *GetStyleGuideContentsRequest, opts ...grpc.CallOption) (*StyleGuideContents, error)
// Lints the requested spec and updates the corresponding API Spec with the
// lint response. This lint response will be available in all subsequent
// Get and List Spec calls to Core service.
LintSpec(ctx context.Context, in *LintSpecRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
LintingServiceClient is the client API for LintingService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewLintingServiceClient
func NewLintingServiceClient(cc grpc.ClientConnInterface) LintingServiceClient
LintingServiceServer
type LintingServiceServer interface {
// Get the style guide being used for linting.
GetStyleGuide(context.Context, *GetStyleGuideRequest) (*StyleGuide, error)
// Update the styleGuide to be used for liniting in by API hub.
UpdateStyleGuide(context.Context, *UpdateStyleGuideRequest) (*StyleGuide, error)
// Get the contents of the style guide.
GetStyleGuideContents(context.Context, *GetStyleGuideContentsRequest) (*StyleGuideContents, error)
// Lints the requested spec and updates the corresponding API Spec with the
// lint response. This lint response will be available in all subsequent
// Get and List Spec calls to Core service.
LintSpec(context.Context, *LintSpecRequest) (*emptypb.Empty, error)
}
LintingServiceServer is the server API for LintingService service.
ListApiOperationsRequest
type ListApiOperationsRequest struct {
// Required. The parent which owns this collection of operations i.e., the API
// version. Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of ApiOperations.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string or a
// boolean. The comparison operator must be one of: `<`, `="">` or
// `=`. Filters are not case sensitive.
//
// The following fields in the `ApiOperation` are eligible for filtering:
// - `name` - The ApiOperation resource name. Allowed comparison
// operators:
// `=`.
// - `details.http_operation.path.path` - The http operation's complete path
// relative to server endpoint. Allowed comparison operators: `=`.
// - `details.http_operation.method` - The http operation method type.
// Allowed comparison operators: `=`.
// - `details.deprecated` - Indicates if the ApiOperation is deprecated.
// Allowed values are True / False indicating the deprycation status of the
// ApiOperation. Allowed comparison operators: `=`.
// - `create_time` - The time at which the ApiOperation was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `details.deprecated="True`" -="" the="" apioperation="" is="" deprecated.="" -="" `details.http_operation.method="GET" and="" create_time="">< \"2021-08-15t14:50:00z\"="" and="" create_time=""> \"2021-08-10T12:00:00Z\"` -
// The method of the http operation of the ApiOperation is _GET_ and the
// spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10
// 12:00:00 UTC_.
// - `details.http_operation.method = GET OR details.http_operation.method =
// POST`. - The http operation of the method of ApiOperation is _GET_ or
// _POST_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of operations to return. The service may
// return fewer than this value. If unspecified, at most 50 operations will be
// returned. The maximum value is 1000; values above 1000 will be coerced to
// 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListApiOperations` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListApiOperations` must match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's request.
func (*ListApiOperationsRequest) Descriptor
func (*ListApiOperationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListApiOperationsRequest.ProtoReflect.Descriptor instead.
func (*ListApiOperationsRequest) GetFilter
func (x *ListApiOperationsRequest) GetFilter() string
func (*ListApiOperationsRequest) GetPageSize
func (x *ListApiOperationsRequest) GetPageSize() int32
func (*ListApiOperationsRequest) GetPageToken
func (x *ListApiOperationsRequest) GetPageToken() string
func (*ListApiOperationsRequest) GetParent
func (x *ListApiOperationsRequest) GetParent() string
func (*ListApiOperationsRequest) ProtoMessage
func (*ListApiOperationsRequest) ProtoMessage()
func (*ListApiOperationsRequest) ProtoReflect
func (x *ListApiOperationsRequest) ProtoReflect() protoreflect.Message
func (*ListApiOperationsRequest) Reset
func (x *ListApiOperationsRequest) Reset()
func (*ListApiOperationsRequest) String
func (x *ListApiOperationsRequest) String() string
ListApiOperationsResponse
type ListApiOperationsResponse struct {
// The operations corresponding to an API version.
// Only following field will be populated in the response: name,
// spec, details.deprecated, details.http_operation.path.path,
// details.http_operation.method and details.documentation.external_uri.
ApiOperations []*ApiOperation `protobuf:"bytes,1,rep,name=api_operations,json=apiOperations,proto3" json:"api_operations,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's response.
func (*ListApiOperationsResponse) Descriptor
func (*ListApiOperationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListApiOperationsResponse.ProtoReflect.Descriptor instead.
func (*ListApiOperationsResponse) GetApiOperations
func (x *ListApiOperationsResponse) GetApiOperations() []*ApiOperation
func (*ListApiOperationsResponse) GetNextPageToken
func (x *ListApiOperationsResponse) GetNextPageToken() string
func (*ListApiOperationsResponse) ProtoMessage
func (*ListApiOperationsResponse) ProtoMessage()
func (*ListApiOperationsResponse) ProtoReflect
func (x *ListApiOperationsResponse) ProtoReflect() protoreflect.Message
func (*ListApiOperationsResponse) Reset
func (x *ListApiOperationsResponse) Reset()
func (*ListApiOperationsResponse) String
func (x *ListApiOperationsResponse) String() string
ListApisRequest
type ListApisRequest struct {
// Required. The parent, which owns this collection of API resources.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of ApiResources.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string. The
// comparison operator must be one of: `<`, `="">`, `:` or `=`. Filters are not
// case sensitive.
//
// The following fields in the `ApiResource` are eligible for filtering:
//
// - `owner.email` - The email of the team which owns the ApiResource.
// Allowed comparison operators: `=`.
// - `create_time` - The time at which the ApiResource was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. -="" `display_name`="" -="" the="" display="" name="" of="" the="" apiresource.="" allowed="" comparison="" operators:="" `="`." -="" `target_user.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" target="" users="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `target_user.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" target="" users="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `team.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" team="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `team.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" team="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `business_unit.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" business="" unit="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `business_unit.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" business="" unit="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `maturity_level.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" maturity="" level="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `maturity_level.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" maturity="" level="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `api_style.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" api="" style="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" -="" `api_style.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" api="" style="" attribute="" associated="" with="" the="" apiresource.="" allowed="" comparison="" operator="" is="" `:`.="" expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `owner.email="\" apihub@google.com\"`"="" -="" -="" the="" owner="" team="" email="" is="" _apihub@google.com_.="" -="" `owner.email="\" apihub@google.com\""="" and="" create_time="">< \"2021-08-15t14:50:00z\"="" and="" create_time=""> \"2021-08-10T12:00:00Z\"` -
// The owner team email is _apihub@google.com_ and the api was created
// before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
// - `owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
// apihub-team-id` - The filter string specifies the APIs where the owner
// team email is _apihub@google.com_ or the id of the allowed value
// associated with the team attribute is _apihub-team-id_.
// - `owner.email = \"apihub@google.com\" OR
// team.enum_values.values.display_name: ApiHub Team` - The filter string
// specifies the APIs where the owner team email is _apihub@google.com_ or
// the display name of the allowed value associated with the team attribute
// is `ApiHub Team`.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of API resources to return. The service may
// return fewer than this value. If unspecified, at most 50 Apis will be
// returned. The maximum value is 1000; values above 1000 will be coerced to
// 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListApis` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListApis` must match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's request.
func (*ListApisRequest) Descriptor
func (*ListApisRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListApisRequest.ProtoReflect.Descriptor instead.
func (*ListApisRequest) GetFilter
func (x *ListApisRequest) GetFilter() string
func (*ListApisRequest) GetPageSize
func (x *ListApisRequest) GetPageSize() int32
func (*ListApisRequest) GetPageToken
func (x *ListApisRequest) GetPageToken() string
func (*ListApisRequest) GetParent
func (x *ListApisRequest) GetParent() string
func (*ListApisRequest) ProtoMessage
func (*ListApisRequest) ProtoMessage()
func (*ListApisRequest) ProtoReflect
func (x *ListApisRequest) ProtoReflect() protoreflect.Message
func (*ListApisRequest) Reset
func (x *ListApisRequest) Reset()
func (*ListApisRequest) String
func (x *ListApisRequest) String() string
ListApisResponse
type ListApisResponse struct {
// The API resources present in the API hub.
Apis []*Api `protobuf:"bytes,1,rep,name=apis,proto3" json:"apis,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's response.
func (*ListApisResponse) Descriptor
func (*ListApisResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListApisResponse.ProtoReflect.Descriptor instead.
func (*ListApisResponse) GetApis
func (x *ListApisResponse) GetApis() []*Api
func (*ListApisResponse) GetNextPageToken
func (x *ListApisResponse) GetNextPageToken() string
func (*ListApisResponse) ProtoMessage
func (*ListApisResponse) ProtoMessage()
func (*ListApisResponse) ProtoReflect
func (x *ListApisResponse) ProtoReflect() protoreflect.Message
func (*ListApisResponse) Reset
func (x *ListApisResponse) Reset()
func (*ListApisResponse) String
func (x *ListApisResponse) String() string
ListAttributesRequest
type ListAttributesRequest 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. An expression that filters the list of Attributes.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string or a
// boolean. The comparison operator must be one of: `<`, `="">` or
// `=`. Filters are not case sensitive.
//
// The following fields in the `Attribute` are eligible for filtering:
//
// - `display_name` - The display name of the Attribute. Allowed
// comparison operators: `=`.
// - `definition_type` - The definition type of the attribute. Allowed
// comparison operators: `=`.
// - `scope` - The scope of the attribute. Allowed comparison operators:
// `=`.
// - `data_type` - The type of the data of the attribute. Allowed
// comparison operators: `=`.
// - `mandatory` - Denotes whether the attribute is mandatory or not.
// Allowed comparison operators: `=`.
// - `create_time` - The time at which the Attribute was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `display_name="production`" -="" -="" the="" display="" name="" of="" the="" attribute="" is="" _production_.="" -="" `(display_name="production)" and="" (create_time="">< \"2021-08-15t14:50:00z\")="" and="" (create_time=""> \"2021-08-10T12:00:00Z\")` -
// The display name of the attribute is _production_ and the attribute was
// created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00
// UTC_.
// - `display_name = production OR scope = api` -
// The attribute where the display name is _production_ or the scope is
// _api_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of attribute resources to return. The service
// may return fewer than this value. If unspecified, at most 50 attributes
// will be returned. The maximum value is 1000; values above 1000 will be
// coerced to 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListAttributes` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListAttributes` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's request.
func (*ListAttributesRequest) Descriptor
func (*ListAttributesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAttributesRequest.ProtoReflect.Descriptor instead.
func (*ListAttributesRequest) GetFilter
func (x *ListAttributesRequest) GetFilter() string
func (*ListAttributesRequest) GetPageSize
func (x *ListAttributesRequest) GetPageSize() int32
func (*ListAttributesRequest) GetPageToken
func (x *ListAttributesRequest) GetPageToken() string
func (*ListAttributesRequest) GetParent
func (x *ListAttributesRequest) GetParent() string
func (*ListAttributesRequest) ProtoMessage
func (*ListAttributesRequest) ProtoMessage()
func (*ListAttributesRequest) ProtoReflect
func (x *ListAttributesRequest) ProtoReflect() protoreflect.Message
func (*ListAttributesRequest) Reset
func (x *ListAttributesRequest) Reset()
func (*ListAttributesRequest) String
func (x *ListAttributesRequest) String() string
ListAttributesResponse
type ListAttributesResponse struct {
// The list of all attributes.
Attributes []*Attribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's response.
func (*ListAttributesResponse) Descriptor
func (*ListAttributesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAttributesResponse.ProtoReflect.Descriptor instead.
func (*ListAttributesResponse) GetAttributes
func (x *ListAttributesResponse) GetAttributes() []*Attribute
func (*ListAttributesResponse) GetNextPageToken
func (x *ListAttributesResponse) GetNextPageToken() string
func (*ListAttributesResponse) ProtoMessage
func (*ListAttributesResponse) ProtoMessage()
func (*ListAttributesResponse) ProtoReflect
func (x *ListAttributesResponse) ProtoReflect() protoreflect.Message
func (*ListAttributesResponse) Reset
func (x *ListAttributesResponse) Reset()
func (*ListAttributesResponse) String
func (x *ListAttributesResponse) String() string
ListDependenciesRequest
type ListDependenciesRequest struct {
// Required. The parent which owns this collection of dependency resources.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of Dependencies.
//
// A filter expression consists of a field name, a comparison operator, and
// a value for filtering. The value must be a string. Allowed comparison
// operator is `=`. Filters are not case sensitive.
//
// The following fields in the `Dependency` are eligible for filtering:
//
// - `consumer.operation_resource_name` - The operation resource name for
// the consumer entity involved in a dependency. Allowed comparison
// operators: `=`.
// - `consumer.external_api_resource_name` - The external api resource name
// for the consumer entity involved in a dependency. Allowed comparison
// operators: `=`.
// - `supplier.operation_resource_name` - The operation resource name for
// the supplier entity involved in a dependency. Allowed comparison
// operators: `=`.
// - `supplier.external_api_resource_name` - The external api resource name
// for the supplier entity involved in a dependency. Allowed comparison
// operators: `=`.
//
// Expressions are combined with either `AND` logic operator or `OR` logical
// operator but not both of them together i.e. only one of the `AND` or `OR`
// operator can be used throughout the filter string and both the operators
// cannot be used together. No other logical operators are supported. At most
// three filter fields are allowed in the filter string and if provided
// more than that then `INVALID_ARGUMENT` error is returned by the API.
//
// For example, `consumer.operation_resource_name =
// \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR
// supplier.operation_resource_name =
// \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"` - The
// dependencies with either consumer or supplier operation resource name as
// _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of dependency resources to return. The service
// may return fewer than this value. If unspecified, at most 50 dependencies
// will be returned. The maximum value is 1000; values above 1000 will be
// coerced to 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListDependencies` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListDependencies` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's request.
func (*ListDependenciesRequest) Descriptor
func (*ListDependenciesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDependenciesRequest.ProtoReflect.Descriptor instead.
func (*ListDependenciesRequest) GetFilter
func (x *ListDependenciesRequest) GetFilter() string
func (*ListDependenciesRequest) GetPageSize
func (x *ListDependenciesRequest) GetPageSize() int32
func (*ListDependenciesRequest) GetPageToken
func (x *ListDependenciesRequest) GetPageToken() string
func (*ListDependenciesRequest) GetParent
func (x *ListDependenciesRequest) GetParent() string
func (*ListDependenciesRequest) ProtoMessage
func (*ListDependenciesRequest) ProtoMessage()
func (*ListDependenciesRequest) ProtoReflect
func (x *ListDependenciesRequest) ProtoReflect() protoreflect.Message
func (*ListDependenciesRequest) Reset
func (x *ListDependenciesRequest) Reset()
func (*ListDependenciesRequest) String
func (x *ListDependenciesRequest) String() string
ListDependenciesResponse
type ListDependenciesResponse struct {
// The dependency resources present in the API hub.
// Only following field will be populated in the response: name.
Dependencies []*Dependency `protobuf:"bytes,1,rep,name=dependencies,proto3" json:"dependencies,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's response.
func (*ListDependenciesResponse) Descriptor
func (*ListDependenciesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDependenciesResponse.ProtoReflect.Descriptor instead.
func (*ListDependenciesResponse) GetDependencies
func (x *ListDependenciesResponse) GetDependencies() []*Dependency
func (*ListDependenciesResponse) GetNextPageToken
func (x *ListDependenciesResponse) GetNextPageToken() string
func (*ListDependenciesResponse) ProtoMessage
func (*ListDependenciesResponse) ProtoMessage()
func (*ListDependenciesResponse) ProtoReflect
func (x *ListDependenciesResponse) ProtoReflect() protoreflect.Message
func (*ListDependenciesResponse) Reset
func (x *ListDependenciesResponse) Reset()
func (*ListDependenciesResponse) String
func (x *ListDependenciesResponse) String() string
ListDeploymentsRequest
type ListDeploymentsRequest struct {
// Required. The parent, which owns this collection of deployment resources.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of Deployments.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string. The
// comparison operator must be one of: `<`, `="">` or
// `=`. Filters are not case sensitive.
//
// The following fields in the `Deployments` are eligible for filtering:
//
// - `display_name` - The display name of the Deployment. Allowed
// comparison operators: `=`.
// - `create_time` - The time at which the Deployment was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. -="" `resource_uri`="" -="" a="" uri="" to="" the="" deployment="" resource.="" allowed="" comparison="" operators:="" `="`." -="" `api_versions`="" -="" the="" api="" versions="" linked="" to="" this="" deployment.="" allowed="" comparison="" operators:="" `:`.="" -="" `deployment_type.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" deployment_type="" attribute="" associated="" with="" the="" deployment.="" allowed="" comparison="" operators:="" `:`.="" -="" `deployment_type.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" deployment_type="" attribute="" associated="" with="" the="" deployment.="" allowed="" comparison="" operators:="" `:`.="" -="" `slo.string_values.values`="" -the="" allowed="" string="" value="" of="" the="" slo="" attribute="" associated="" with="" the="" deployment.="" allowed="" comparison="" operators:="" `:`.="" -="" `environment.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" environment="" attribute="" associated="" with="" the="" deployment.="" allowed="" comparison="" operators:="" `:`.="" -="" `environment.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" environment="" attribute="" associated="" with="" the="" deployment.="" allowed="" comparison="" operators:="" `:`.="" expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `environment.enum_values.values.id:="" staging-id`="" -="" the="" allowed="" value="" id="" of="" the="" environment="" attribute="" associated="" with="" the="" deployment="" is="" _staging-id_.="" -="" `environment.enum_values.values.display_name:="" \"staging="" deployment\"`="" -="" the="" allowed="" value="" display="" name="" of="" the="" environment="" attribute="" associated="" with="" the="" deployment="" is="" `staging="" deployment`.="" -="" `environment.enum_values.values.id:="" production-id="" and="" create_time="">< \"2021-08-15t14:50:00z\"="" and="" create_time=""> \"2021-08-10T12:00:00Z\"` -
// The allowed value id of the environment attribute associated with the
// Deployment is _production-id_ and Deployment was created before
// _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
// - `environment.enum_values.values.id: production-id OR
// slo.string_values.values: \"99.99%\"`
// - The allowed value id of the environment attribute Deployment is
// _production-id_ or string value of the slo attribute is _99.99%_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of deployment resources to return. The service
// may return fewer than this value. If unspecified, at most 50 deployments
// will be returned. The maximum value is 1000; values above 1000 will be
// coerced to 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListDeployments` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListDeployments` must match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's request.
func (*ListDeploymentsRequest) Descriptor
func (*ListDeploymentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDeploymentsRequest.ProtoReflect.Descriptor instead.
func (*ListDeploymentsRequest) GetFilter
func (x *ListDeploymentsRequest) GetFilter() string
func (*ListDeploymentsRequest) GetPageSize
func (x *ListDeploymentsRequest) GetPageSize() int32
func (*ListDeploymentsRequest) GetPageToken
func (x *ListDeploymentsRequest) GetPageToken() string
func (*ListDeploymentsRequest) GetParent
func (x *ListDeploymentsRequest) GetParent() string
func (*ListDeploymentsRequest) ProtoMessage
func (*ListDeploymentsRequest) ProtoMessage()
func (*ListDeploymentsRequest) ProtoReflect
func (x *ListDeploymentsRequest) ProtoReflect() protoreflect.Message
func (*ListDeploymentsRequest) Reset
func (x *ListDeploymentsRequest) Reset()
func (*ListDeploymentsRequest) String
func (x *ListDeploymentsRequest) String() string
ListDeploymentsResponse
type ListDeploymentsResponse struct {
// The deployment resources present in the API hub.
Deployments []*Deployment `protobuf:"bytes,1,rep,name=deployments,proto3" json:"deployments,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's response.
func (*ListDeploymentsResponse) Descriptor
func (*ListDeploymentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDeploymentsResponse.ProtoReflect.Descriptor instead.
func (*ListDeploymentsResponse) GetDeployments
func (x *ListDeploymentsResponse) GetDeployments() []*Deployment
func (*ListDeploymentsResponse) GetNextPageToken
func (x *ListDeploymentsResponse) GetNextPageToken() string
func (*ListDeploymentsResponse) ProtoMessage
func (*ListDeploymentsResponse) ProtoMessage()
func (*ListDeploymentsResponse) ProtoReflect
func (x *ListDeploymentsResponse) ProtoReflect() protoreflect.Message
func (*ListDeploymentsResponse) Reset
func (x *ListDeploymentsResponse) Reset()
func (*ListDeploymentsResponse) String
func (x *ListDeploymentsResponse) String() string
ListExternalApisRequest
type ListExternalApisRequest struct {
// Required. The parent, which owns this collection of External API resources.
// Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of External API resources to return. The
// service may return fewer than this value. If unspecified, at most 50
// ExternalApis will be returned. The maximum value is 1000; values above 1000
// will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListExternalApis` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListExternalApis` must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's request.
func (*ListExternalApisRequest) Descriptor
func (*ListExternalApisRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListExternalApisRequest.ProtoReflect.Descriptor instead.
func (*ListExternalApisRequest) GetPageSize
func (x *ListExternalApisRequest) GetPageSize() int32
func (*ListExternalApisRequest) GetPageToken
func (x *ListExternalApisRequest) GetPageToken() string
func (*ListExternalApisRequest) GetParent
func (x *ListExternalApisRequest) GetParent() string
func (*ListExternalApisRequest) ProtoMessage
func (*ListExternalApisRequest) ProtoMessage()
func (*ListExternalApisRequest) ProtoReflect
func (x *ListExternalApisRequest) ProtoReflect() protoreflect.Message
func (*ListExternalApisRequest) Reset
func (x *ListExternalApisRequest) Reset()
func (*ListExternalApisRequest) String
func (x *ListExternalApisRequest) String() string
ListExternalApisResponse
type ListExternalApisResponse struct {
// The External API resources present in the API hub.
// Only following fields will be populated in the response: name,
// display_name, documentation.external_uri.
ExternalApis []*ExternalApi `protobuf:"bytes,1,rep,name=external_apis,json=externalApis,proto3" json:"external_apis,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's response.
func (*ListExternalApisResponse) Descriptor
func (*ListExternalApisResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListExternalApisResponse.ProtoReflect.Descriptor instead.
func (*ListExternalApisResponse) GetExternalApis
func (x *ListExternalApisResponse) GetExternalApis() []*ExternalApi
func (*ListExternalApisResponse) GetNextPageToken
func (x *ListExternalApisResponse) GetNextPageToken() string
func (*ListExternalApisResponse) ProtoMessage
func (*ListExternalApisResponse) ProtoMessage()
func (*ListExternalApisResponse) ProtoReflect
func (x *ListExternalApisResponse) ProtoReflect() protoreflect.Message
func (*ListExternalApisResponse) Reset
func (x *ListExternalApisResponse) Reset()
func (*ListExternalApisResponse) String
func (x *ListExternalApisResponse) String() string
ListHostProjectRegistrationsRequest
type ListHostProjectRegistrationsRequest struct {
// Required. The parent, which owns this collection of host projects.
// Format: `projects/*/locations/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of host project registrations to return. The
// service may return fewer than this value. If unspecified, at most 50 host
// project registrations will be returned. The maximum value is 1000; values
// above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous
// `ListHostProjectRegistrations` call. Provide this to retrieve the
// subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListHostProjectRegistrations` must match the call that provided the page
// token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. An expression that filters the list of HostProjectRegistrations.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string. All
// standard operators as documented at https://google.aip.dev/160 are
// supported.
//
// The following fields in the `HostProjectRegistration` are eligible for
// filtering:
//
// - `name` - The name of the HostProjectRegistration.
// - `create_time` - The time at which the HostProjectRegistration was
// created. The value should be in the
// (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
// - `gcp_project` - The Google cloud project associated with the
// HostProjectRegistration.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Hint for how to order the results.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's request.
func (*ListHostProjectRegistrationsRequest) Descriptor
func (*ListHostProjectRegistrationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListHostProjectRegistrationsRequest.ProtoReflect.Descriptor instead.
func (*ListHostProjectRegistrationsRequest) GetFilter
func (x *ListHostProjectRegistrationsRequest) GetFilter() string
func (*ListHostProjectRegistrationsRequest) GetOrderBy
func (x *ListHostProjectRegistrationsRequest) GetOrderBy() string
func (*ListHostProjectRegistrationsRequest) GetPageSize
func (x *ListHostProjectRegistrationsRequest) GetPageSize() int32
func (*ListHostProjectRegistrationsRequest) GetPageToken
func (x *ListHostProjectRegistrationsRequest) GetPageToken() string
func (*ListHostProjectRegistrationsRequest) GetParent
func (x *ListHostProjectRegistrationsRequest) GetParent() string
func (*ListHostProjectRegistrationsRequest) ProtoMessage
func (*ListHostProjectRegistrationsRequest) ProtoMessage()
func (*ListHostProjectRegistrationsRequest) ProtoReflect
func (x *ListHostProjectRegistrationsRequest) ProtoReflect() protoreflect.Message
func (*ListHostProjectRegistrationsRequest) Reset
func (x *ListHostProjectRegistrationsRequest) Reset()
func (*ListHostProjectRegistrationsRequest) String
func (x *ListHostProjectRegistrationsRequest) String() string
ListHostProjectRegistrationsResponse
type ListHostProjectRegistrationsResponse struct {
// The list of host project registrations.
HostProjectRegistrations []*HostProjectRegistration `protobuf:"bytes,1,rep,name=host_project_registrations,json=hostProjectRegistrations,proto3" json:"host_project_registrations,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's response.
func (*ListHostProjectRegistrationsResponse) Descriptor
func (*ListHostProjectRegistrationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListHostProjectRegistrationsResponse.ProtoReflect.Descriptor instead.
func (*ListHostProjectRegistrationsResponse) GetHostProjectRegistrations
func (x *ListHostProjectRegistrationsResponse) GetHostProjectRegistrations() []*HostProjectRegistration
func (*ListHostProjectRegistrationsResponse) GetNextPageToken
func (x *ListHostProjectRegistrationsResponse) GetNextPageToken() string
func (*ListHostProjectRegistrationsResponse) ProtoMessage
func (*ListHostProjectRegistrationsResponse) ProtoMessage()
func (*ListHostProjectRegistrationsResponse) ProtoReflect
func (x *ListHostProjectRegistrationsResponse) ProtoReflect() protoreflect.Message
func (*ListHostProjectRegistrationsResponse) Reset
func (x *ListHostProjectRegistrationsResponse) Reset()
func (*ListHostProjectRegistrationsResponse) String
func (x *ListHostProjectRegistrationsResponse) String() string
ListRuntimeProjectAttachmentsRequest
type ListRuntimeProjectAttachmentsRequest struct {
// Required. The parent, which owns this collection of runtime project
// attachments. Format: `projects/{project}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of runtime project attachments to return. The
// service may return fewer than this value. If unspecified, at most 50
// runtime project attachments will be returned. The maximum value is 1000;
// values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous
// `ListRuntimeProjectAttachments` call. Provide this to retrieve the
// subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListRuntimeProjectAttachments` must match the call that provided the page
// token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. An expression that filters the list of RuntimeProjectAttachments.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string. All
// standard operators as documented at https://google.aip.dev/160 are
// supported.
//
// The following fields in the `RuntimeProjectAttachment` are eligible for
// filtering:
//
// - `name` - The name of the RuntimeProjectAttachment.
// - `create_time` - The time at which the RuntimeProjectAttachment was
// created. The value should be in the
// (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
// - `runtime_project` - The Google cloud project associated with the
// RuntimeProjectAttachment.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Hint for how to order the results.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's request.
func (*ListRuntimeProjectAttachmentsRequest) Descriptor
func (*ListRuntimeProjectAttachmentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimeProjectAttachmentsRequest.ProtoReflect.Descriptor instead.
func (*ListRuntimeProjectAttachmentsRequest) GetFilter
func (x *ListRuntimeProjectAttachmentsRequest) GetFilter() string
func (*ListRuntimeProjectAttachmentsRequest) GetOrderBy
func (x *ListRuntimeProjectAttachmentsRequest) GetOrderBy() string
func (*ListRuntimeProjectAttachmentsRequest) GetPageSize
func (x *ListRuntimeProjectAttachmentsRequest) GetPageSize() int32
func (*ListRuntimeProjectAttachmentsRequest) GetPageToken
func (x *ListRuntimeProjectAttachmentsRequest) GetPageToken() string
func (*ListRuntimeProjectAttachmentsRequest) GetParent
func (x *ListRuntimeProjectAttachmentsRequest) GetParent() string
func (*ListRuntimeProjectAttachmentsRequest) ProtoMessage
func (*ListRuntimeProjectAttachmentsRequest) ProtoMessage()
func (*ListRuntimeProjectAttachmentsRequest) ProtoReflect
func (x *ListRuntimeProjectAttachmentsRequest) ProtoReflect() protoreflect.Message
func (*ListRuntimeProjectAttachmentsRequest) Reset
func (x *ListRuntimeProjectAttachmentsRequest) Reset()
func (*ListRuntimeProjectAttachmentsRequest) String
func (x *ListRuntimeProjectAttachmentsRequest) String() string
ListRuntimeProjectAttachmentsResponse
type ListRuntimeProjectAttachmentsResponse struct {
// List of runtime project attachments.
RuntimeProjectAttachments []*RuntimeProjectAttachment `protobuf:"bytes,1,rep,name=runtime_project_attachments,json=runtimeProjectAttachments,proto3" json:"runtime_project_attachments,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.
func (*ListRuntimeProjectAttachmentsResponse) Descriptor
func (*ListRuntimeProjectAttachmentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimeProjectAttachmentsResponse.ProtoReflect.Descriptor instead.
func (*ListRuntimeProjectAttachmentsResponse) GetNextPageToken
func (x *ListRuntimeProjectAttachmentsResponse) GetNextPageToken() string
func (*ListRuntimeProjectAttachmentsResponse) GetRuntimeProjectAttachments
func (x *ListRuntimeProjectAttachmentsResponse) GetRuntimeProjectAttachments() []*RuntimeProjectAttachment
func (*ListRuntimeProjectAttachmentsResponse) ProtoMessage
func (*ListRuntimeProjectAttachmentsResponse) ProtoMessage()
func (*ListRuntimeProjectAttachmentsResponse) ProtoReflect
func (x *ListRuntimeProjectAttachmentsResponse) ProtoReflect() protoreflect.Message
func (*ListRuntimeProjectAttachmentsResponse) Reset
func (x *ListRuntimeProjectAttachmentsResponse) Reset()
func (*ListRuntimeProjectAttachmentsResponse) String
func (x *ListRuntimeProjectAttachmentsResponse) String() string
ListSpecsRequest
type ListSpecsRequest struct {
// Required. The parent, which owns this collection of specs.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of Specs.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string. The
// comparison operator must be one of: `<`, `="">`, `:` or `=`. Filters are not
// case sensitive.
//
// The following fields in the `Spec` are eligible for filtering:
//
// - `display_name` - The display name of the Spec. Allowed comparison
// operators: `=`.
// - `create_time` - The time at which the Spec was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. -="" `spec_type.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" spec_type="" attribute="" associated="" with="" the="" spec.="" allowed="" comparison="" operators:="" `:`.="" -="" `spec_type.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" spec_type="" attribute="" associated="" with="" the="" spec.="" allowed="" comparison="" operators:="" `:`.="" -="" `lint_response.json_values.values`="" -="" the="" json="" value="" of="" the="" lint_response="" attribute="" associated="" with="" the="" spec.="" allowed="" comparison="" operators:="" `:`.="" -="" `mime_type`="" -="" the="" mime="" type="" of="" the="" spec.="" allowed="" comparison="" operators:="" `="`." expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `spec_type.enum_values.values.id:="" rest-id`="" -="" the="" filter="" string="" specifies="" that="" the="" id="" of="" the="" allowed="" value="" associated="" with="" the="" spec_type="" attribute="" is="" _rest-id_.="" -="" `spec_type.enum_values.values.display_name:="" \"rest="" display="" name\"`="" -="" the="" filter="" string="" specifies="" that="" the="" display="" name="" of="" the="" allowed="" value="" associated="" with="" the="" spec_type="" attribute="" is="" `rest="" display="" name`.="" -="" `spec_type.enum_values.values.id:="" grpc-id="" and="" create_time="">< \"2021-08-15t14:50:00z\"="" and="" create_time=""> \"2021-08-10T12:00:00Z\"` -
// The id of the allowed value associated with the spec_type attribute is
// _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and
// after _2021-08-10 12:00:00 UTC_.
// - `spec_type.enum_values.values.id: rest-id OR
// spec_type.enum_values.values.id: grpc-id`
// - The id of the allowed value associated with the spec_type attribute is
// _rest-id_ or _grpc-id_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of specs to return. The service may return
// fewer than this value. If unspecified, at most 50 specs will be
// returned. The maximum value is 1000; values above 1000 will be coerced to
// 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListSpecs` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListSpecs` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListSpecs][ListSpecs] method's request.
func (*ListSpecsRequest) Descriptor
func (*ListSpecsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSpecsRequest.ProtoReflect.Descriptor instead.
func (*ListSpecsRequest) GetFilter
func (x *ListSpecsRequest) GetFilter() string
func (*ListSpecsRequest) GetPageSize
func (x *ListSpecsRequest) GetPageSize() int32
func (*ListSpecsRequest) GetPageToken
func (x *ListSpecsRequest) GetPageToken() string
func (*ListSpecsRequest) GetParent
func (x *ListSpecsRequest) GetParent() string
func (*ListSpecsRequest) ProtoMessage
func (*ListSpecsRequest) ProtoMessage()
func (*ListSpecsRequest) ProtoReflect
func (x *ListSpecsRequest) ProtoReflect() protoreflect.Message
func (*ListSpecsRequest) Reset
func (x *ListSpecsRequest) Reset()
func (*ListSpecsRequest) String
func (x *ListSpecsRequest) String() string
ListSpecsResponse
type ListSpecsResponse struct {
// The specs corresponding to an API.
Specs []*Spec `protobuf:"bytes,1,rep,name=specs,proto3" json:"specs,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListSpecs][google.cloud.apihub.v1.ApiHub.ListSpecs] method's response.
func (*ListSpecsResponse) Descriptor
func (*ListSpecsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSpecsResponse.ProtoReflect.Descriptor instead.
func (*ListSpecsResponse) GetNextPageToken
func (x *ListSpecsResponse) GetNextPageToken() string
func (*ListSpecsResponse) GetSpecs
func (x *ListSpecsResponse) GetSpecs() []*Spec
func (*ListSpecsResponse) ProtoMessage
func (*ListSpecsResponse) ProtoMessage()
func (*ListSpecsResponse) ProtoReflect
func (x *ListSpecsResponse) ProtoReflect() protoreflect.Message
func (*ListSpecsResponse) Reset
func (x *ListSpecsResponse) Reset()
func (*ListSpecsResponse) String
func (x *ListSpecsResponse) String() string
ListVersionsRequest
type ListVersionsRequest struct {
// Required. The parent which owns this collection of API versions i.e., the
// API resource Format: `projects/{project}/locations/{location}/apis/{api}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An expression that filters the list of Versions.
//
// A filter expression consists of a field name, a comparison
// operator, and a value for filtering. The value must be a string, a
// number, or a boolean. The comparison operator must be one of: `<`, `="">` or
// `=`. Filters are not case sensitive.
//
// The following fields in the `Version` are eligible for filtering:
//
// - `display_name` - The display name of the Version. Allowed
// comparison operators: `=`.
// - `create_time` - The time at which the Version was created. The
// value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
// format. Allowed comparison operators: `>` and `<`. -="" `lifecycle.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" lifecycle="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" -="" `lifecycle.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" lifecycle="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" -="" `compliance.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" compliances="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" -="" `compliance.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" compliances="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" -="" `accreditation.enum_values.values.id`="" -="" the="" allowed="" value="" id="" of="" the="" accreditations="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" -="" `accreditation.enum_values.values.display_name`="" -="" the="" allowed="" value="" display="" name="" of="" the="" accreditations="" attribute="" associated="" with="" the="" version.="" allowed="" comparison="" operators:="" `:`.="" expressions="" are="" combined="" with="" either="" `and`="" logic="" operator="" or="" `or`="" logical="" operator="" but="" not="" both="" of="" them="" together="" i.e.="" only="" one="" of="" the="" `and`="" or="" `or`="" operator="" can="" be="" used="" throughout="" the="" filter="" string="" and="" both="" the="" operators="" cannot="" be="" used="" together.="" no="" other="" logical="" operators="" are="" supported.="" at="" most="" three="" filter="" fields="" are="" allowed="" in="" the="" filter="" string="" and="" if="" provided="" more="" than="" that="" then="" `invalid_argument`="" error="" is="" returned="" by="" the="" api.="" here="" are="" a="" few="" examples:="" -="" `lifecycle.enum_values.values.id:="" preview-id`="" -="" the="" filter="" string="" specifies="" that="" the="" id="" of="" the="" allowed="" value="" associated="" with="" the="" lifecycle="" attribute="" of="" the="" version="" is="" _preview-id_.="" -="" `lifecycle.enum_values.values.display_name:="" \"preview="" display="" name\"`="" -="" the="" filter="" string="" specifies="" that="" the="" display="" name="" of="" the="" allowed="" value="" associated="" with="" the="" lifecycle="" attribute="" of="" the="" version="" is="" `preview="" display="" name`.="" -="" `lifecycle.enum_values.values.id:="" preview-id="" and="" create_time="">< \"2021-08-15t14:50:00z\"="" and="" create_time=""> \"2021-08-10T12:00:00Z\"` -
// The id of the allowed value associated with the lifecycle attribute of
// the Version is _preview-id_ and it was created before _2021-08-15
// 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
// - `compliance.enum_values.values.id: gdpr-id OR
// compliance.enum_values.values.id: pci-dss-id`
// - The id of the allowed value associated with the compliance attribute is
// _gdpr-id_ or _pci-dss-id_.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of versions to return. The service may return
// fewer than this value. If unspecified, at most 50 versions will be
// returned. The maximum value is 1000; values above 1000 will be coerced to
// 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListVersions` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters (except page_size) provided to
// `ListVersions` must match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's request.
func (*ListVersionsRequest) Descriptor
func (*ListVersionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListVersionsRequest.ProtoReflect.Descriptor instead.
func (*ListVersionsRequest) GetFilter
func (x *ListVersionsRequest) GetFilter() string
func (*ListVersionsRequest) GetPageSize
func (x *ListVersionsRequest) GetPageSize() int32
func (*ListVersionsRequest) GetPageToken
func (x *ListVersionsRequest) GetPageToken() string
func (*ListVersionsRequest) GetParent
func (x *ListVersionsRequest) GetParent() string
func (*ListVersionsRequest) ProtoMessage
func (*ListVersionsRequest) ProtoMessage()
func (*ListVersionsRequest) ProtoReflect
func (x *ListVersionsRequest) ProtoReflect() protoreflect.Message
func (*ListVersionsRequest) Reset
func (x *ListVersionsRequest) Reset()
func (*ListVersionsRequest) String
func (x *ListVersionsRequest) String() string
ListVersionsResponse
type ListVersionsResponse struct {
// The versions corresponding to an API.
Versions []*Version `protobuf:"bytes,1,rep,name=versions,proto3" json:"versions,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's response.
func (*ListVersionsResponse) Descriptor
func (*ListVersionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListVersionsResponse.ProtoReflect.Descriptor instead.
func (*ListVersionsResponse) GetNextPageToken
func (x *ListVersionsResponse) GetNextPageToken() string
func (*ListVersionsResponse) GetVersions
func (x *ListVersionsResponse) GetVersions() []*Version
func (*ListVersionsResponse) ProtoMessage
func (*ListVersionsResponse) ProtoMessage()
func (*ListVersionsResponse) ProtoReflect
func (x *ListVersionsResponse) ProtoReflect() protoreflect.Message
func (*ListVersionsResponse) Reset
func (x *ListVersionsResponse) Reset()
func (*ListVersionsResponse) String
func (x *ListVersionsResponse) String() string
LookupApiHubInstanceRequest
type LookupApiHubInstanceRequest struct {
// Required. There will always be only one Api Hub instance for a GCP project
// across all locations.
// 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"`
// contains filtered or unexported fields
}
The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's request.
func (*LookupApiHubInstanceRequest) Descriptor
func (*LookupApiHubInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use LookupApiHubInstanceRequest.ProtoReflect.Descriptor instead.
func (*LookupApiHubInstanceRequest) GetParent
func (x *LookupApiHubInstanceRequest) GetParent() string
func (*LookupApiHubInstanceRequest) ProtoMessage
func (*LookupApiHubInstanceRequest) ProtoMessage()
func (*LookupApiHubInstanceRequest) ProtoReflect
func (x *LookupApiHubInstanceRequest) ProtoReflect() protoreflect.Message
func (*LookupApiHubInstanceRequest) Reset
func (x *LookupApiHubInstanceRequest) Reset()
func (*LookupApiHubInstanceRequest) String
func (x *LookupApiHubInstanceRequest) String() string
LookupApiHubInstanceResponse
type LookupApiHubInstanceResponse struct {
// API Hub instance for a project if it exists, empty otherwise.
ApiHubInstance *ApiHubInstance `protobuf:"bytes,1,opt,name=api_hub_instance,json=apiHubInstance,proto3" json:"api_hub_instance,omitempty"`
// contains filtered or unexported fields
}
The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's response.`
func (*LookupApiHubInstanceResponse) Descriptor
func (*LookupApiHubInstanceResponse) Descriptor() ([]byte, []int)
Deprecated: Use LookupApiHubInstanceResponse.ProtoReflect.Descriptor instead.
func (*LookupApiHubInstanceResponse) GetApiHubInstance
func (x *LookupApiHubInstanceResponse) GetApiHubInstance() *ApiHubInstance
func (*LookupApiHubInstanceResponse) ProtoMessage
func (*LookupApiHubInstanceResponse) ProtoMessage()
func (*LookupApiHubInstanceResponse) ProtoReflect
func (x *LookupApiHubInstanceResponse) ProtoReflect() protoreflect.Message
func (*LookupApiHubInstanceResponse) Reset
func (x *LookupApiHubInstanceResponse) Reset()
func (*LookupApiHubInstanceResponse) String
func (x *LookupApiHubInstanceResponse) String() string
LookupRuntimeProjectAttachmentRequest
type LookupRuntimeProjectAttachmentRequest struct {
// Required. Runtime project ID to look up runtime project attachment for.
// Lookup happens across all regions. Expected format:
// `projects/{project}/locations/{location}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The [LookupRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.LookupRuntimeProjectAttachment] method's request.
func (*LookupRuntimeProjectAttachmentRequest) Descriptor
func (*LookupRuntimeProjectAttachmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use LookupRuntimeProjectAttachmentRequest.ProtoReflect.Descriptor instead.
func (*LookupRuntimeProjectAttachmentRequest) GetName
func (x *LookupRuntimeProjectAttachmentRequest) GetName() string
func (*LookupRuntimeProjectAttachmentRequest) ProtoMessage
func (*LookupRuntimeProjectAttachmentRequest) ProtoMessage()
func (*LookupRuntimeProjectAttachmentRequest) ProtoReflect
func (x *LookupRuntimeProjectAttachmentRequest) ProtoReflect() protoreflect.Message
func (*LookupRuntimeProjectAttachmentRequest) Reset
func (x *LookupRuntimeProjectAttachmentRequest) Reset()
func (*LookupRuntimeProjectAttachmentRequest) String
func (x *LookupRuntimeProjectAttachmentRequest) String() string
LookupRuntimeProjectAttachmentResponse
type LookupRuntimeProjectAttachmentResponse struct {
// Runtime project attachment for a project if exists, empty otherwise.
RuntimeProjectAttachment *RuntimeProjectAttachment `protobuf:"bytes,1,opt,name=runtime_project_attachment,json=runtimeProjectAttachment,proto3" json:"runtime_project_attachment,omitempty"`
// contains filtered or unexported fields
}
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.
func (*LookupRuntimeProjectAttachmentResponse) Descriptor
func (*LookupRuntimeProjectAttachmentResponse) Descriptor() ([]byte, []int)
Deprecated: Use LookupRuntimeProjectAttachmentResponse.ProtoReflect.Descriptor instead.
func (*LookupRuntimeProjectAttachmentResponse) GetRuntimeProjectAttachment
func (x *LookupRuntimeProjectAttachmentResponse) GetRuntimeProjectAttachment() *RuntimeProjectAttachment
func (*LookupRuntimeProjectAttachmentResponse) ProtoMessage
func (*LookupRuntimeProjectAttachmentResponse) ProtoMessage()
func (*LookupRuntimeProjectAttachmentResponse) ProtoReflect
func (x *LookupRuntimeProjectAttachmentResponse) ProtoReflect() protoreflect.Message
func (*LookupRuntimeProjectAttachmentResponse) Reset
func (x *LookupRuntimeProjectAttachmentResponse) Reset()
func (*LookupRuntimeProjectAttachmentResponse) String
func (x *LookupRuntimeProjectAttachmentResponse) String() string
OpenApiSpecDetails
type OpenApiSpecDetails struct {
// Output only. The format of the spec.
Format OpenApiSpecDetails_Format `protobuf:"varint,1,opt,name=format,proto3,enum=google.cloud.apihub.v1.OpenApiSpecDetails_Format" json:"format,omitempty"`
// Output only. The version in the spec.
// This maps to `info.version` in OpenAPI spec.
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// Output only. Owner details for the spec.
// This maps to `info.contact` in OpenAPI spec.
Owner *Owner `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"`
// contains filtered or unexported fields
}
OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in [SpecDetails][google.cloud.apihub.v1.SpecDetails].
func (*OpenApiSpecDetails) Descriptor
func (*OpenApiSpecDetails) Descriptor() ([]byte, []int)
Deprecated: Use OpenApiSpecDetails.ProtoReflect.Descriptor instead.
func (*OpenApiSpecDetails) GetFormat
func (x *OpenApiSpecDetails) GetFormat() OpenApiSpecDetails_Format
func (*OpenApiSpecDetails) GetOwner
func (x *OpenApiSpecDetails) GetOwner() *Owner
func (*OpenApiSpecDetails) GetVersion
func (x *OpenApiSpecDetails) GetVersion() string
func (*OpenApiSpecDetails) ProtoMessage
func (*OpenApiSpecDetails) ProtoMessage()
func (*OpenApiSpecDetails) ProtoReflect
func (x *OpenApiSpecDetails) ProtoReflect() protoreflect.Message
func (*OpenApiSpecDetails) Reset
func (x *OpenApiSpecDetails) Reset()
func (*OpenApiSpecDetails) String
func (x *OpenApiSpecDetails) String() string
OpenApiSpecDetails_Format
type OpenApiSpecDetails_Format int32
Enumeration of spec formats.
OpenApiSpecDetails_FORMAT_UNSPECIFIED, OpenApiSpecDetails_OPEN_API_SPEC_2_0, OpenApiSpecDetails_OPEN_API_SPEC_3_0, OpenApiSpecDetails_OPEN_API_SPEC_3_1
const (
// SpecFile type unspecified.
OpenApiSpecDetails_FORMAT_UNSPECIFIED OpenApiSpecDetails_Format = 0
// OpenAPI Spec v2.0.
OpenApiSpecDetails_OPEN_API_SPEC_2_0 OpenApiSpecDetails_Format = 1
// OpenAPI Spec v3.0.
OpenApiSpecDetails_OPEN_API_SPEC_3_0 OpenApiSpecDetails_Format = 2
// OpenAPI Spec v3.1.
OpenApiSpecDetails_OPEN_API_SPEC_3_1 OpenApiSpecDetails_Format = 3
)
func (OpenApiSpecDetails_Format) Descriptor
func (OpenApiSpecDetails_Format) Descriptor() protoreflect.EnumDescriptor
func (OpenApiSpecDetails_Format) Enum
func (x OpenApiSpecDetails_Format) Enum() *OpenApiSpecDetails_Format
func (OpenApiSpecDetails_Format) EnumDescriptor
func (OpenApiSpecDetails_Format) EnumDescriptor() ([]byte, []int)
Deprecated: Use OpenApiSpecDetails_Format.Descriptor instead.
func (OpenApiSpecDetails_Format) Number
func (x OpenApiSpecDetails_Format) Number() protoreflect.EnumNumber
func (OpenApiSpecDetails_Format) String
func (x OpenApiSpecDetails_Format) String() string
func (OpenApiSpecDetails_Format) Type
func (OpenApiSpecDetails_Format) Type() protoreflect.EnumType
OperationDetails
type OperationDetails struct {
// Types that are assignable to Operation:
//
// *OperationDetails_HttpOperation
Operation isOperationDetails_Operation `protobuf_oneof:"operation"`
// Output only. Description of the operation behavior.
// For OpenAPI spec, this will map to `operation.description` in the
// spec, in case description is empty, `operation.summary` will be used.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Additional external documentation for this operation.
// For OpenAPI spec, this will map to `operation.documentation` in the spec.
Documentation *Documentation `protobuf:"bytes,2,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Output only. For OpenAPI spec, this will be set if `operation.deprecated`is
// marked as `true` in the spec.
Deprecated bool `protobuf:"varint,3,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
// contains filtered or unexported fields
}
The operation details parsed from the spec.
func (*OperationDetails) Descriptor
func (*OperationDetails) Descriptor() ([]byte, []int)
Deprecated: Use OperationDetails.ProtoReflect.Descriptor instead.
func (*OperationDetails) GetDeprecated
func (x *OperationDetails) GetDeprecated() bool
func (*OperationDetails) GetDescription
func (x *OperationDetails) GetDescription() string
func (*OperationDetails) GetDocumentation
func (x *OperationDetails) GetDocumentation() *Documentation
func (*OperationDetails) GetHttpOperation
func (x *OperationDetails) GetHttpOperation() *HttpOperation
func (*OperationDetails) GetOperation
func (m *OperationDetails) GetOperation() isOperationDetails_Operation
func (*OperationDetails) ProtoMessage
func (*OperationDetails) ProtoMessage()
func (*OperationDetails) ProtoReflect
func (x *OperationDetails) ProtoReflect() protoreflect.Message
func (*OperationDetails) Reset
func (x *OperationDetails) Reset()
func (*OperationDetails) String
func (x *OperationDetails) String() string
OperationDetails_HttpOperation
type OperationDetails_HttpOperation struct {
// The HTTP Operation.
HttpOperation *HttpOperation `protobuf:"bytes,4,opt,name=http_operation,json=httpOperation,proto3,oneof"`
}
OperationMetadata
type OperationMetadata struct {
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Output only. Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Output only. Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have been cancelled successfully
// have [Operation.error][] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`.
RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// Output only. API version used to start the operation.
ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// contains filtered or unexported fields
}
Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() string
func (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
func (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
func (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() bool
func (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() string
func (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() string
func (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() string
func (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()
func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Message
func (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()
func (*OperationMetadata) String
func (x *OperationMetadata) String() string
Owner
type Owner struct {
// Optional. The name of the owner.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The email of the owner.
Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
// contains filtered or unexported fields
}
Owner details.
func (*Owner) Descriptor
Deprecated: Use Owner.ProtoReflect.Descriptor instead.
func (*Owner) GetDisplayName
func (*Owner) GetEmail
func (*Owner) ProtoMessage
func (*Owner) ProtoMessage()
func (*Owner) ProtoReflect
func (x *Owner) ProtoReflect() protoreflect.Message
func (*Owner) Reset
func (x *Owner) Reset()
func (*Owner) String
Path
type Path struct {
// Output only. Complete path relative to server endpoint.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// Output only. A short description for the path applicable to all operations.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
The path details derived from the spec.
func (*Path) Descriptor
Deprecated: Use Path.ProtoReflect.Descriptor instead.
func (*Path) GetDescription
func (*Path) GetPath
func (*Path) ProtoMessage
func (*Path) ProtoMessage()
func (*Path) ProtoReflect
func (x *Path) ProtoReflect() protoreflect.Message
func (*Path) Reset
func (x *Path) Reset()
func (*Path) String
Plugin
type Plugin struct {
// Identifier. The name of the plugin.
// Format: `projects/{project}/locations/{location}/plugins/{plugin}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the plugin. Max length is 50 characters
// (Unicode code points).
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The type of the API.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-plugin-type`
// attribute.
// The number of allowed values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Type *AttributeValues `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
// Optional. The plugin description. Max length is 2000 characters (Unicode
// code points).
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Represents the state of the plugin.
State Plugin_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.apihub.v1.Plugin_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
A plugin resource in the API Hub.
func (*Plugin) Descriptor
Deprecated: Use Plugin.ProtoReflect.Descriptor instead.
func (*Plugin) GetDescription
func (*Plugin) GetDisplayName
func (*Plugin) GetName
func (*Plugin) GetState
func (x *Plugin) GetState() Plugin_State
func (*Plugin) GetType
func (x *Plugin) GetType() *AttributeValues
func (*Plugin) ProtoMessage
func (*Plugin) ProtoMessage()
func (*Plugin) ProtoReflect
func (x *Plugin) ProtoReflect() protoreflect.Message
func (*Plugin) Reset
func (x *Plugin) Reset()
func (*Plugin) String
Plugin_State
type Plugin_State int32
Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.
Plugin_STATE_UNSPECIFIED, Plugin_ENABLED, Plugin_DISABLED
const (
// The default value. This value is used if the state is omitted.
Plugin_STATE_UNSPECIFIED Plugin_State = 0
// The plugin is enabled.
Plugin_ENABLED Plugin_State = 1
// The plugin is disabled.
Plugin_DISABLED Plugin_State = 2
)
func (Plugin_State) Descriptor
func (Plugin_State) Descriptor() protoreflect.EnumDescriptor
func (Plugin_State) Enum
func (x Plugin_State) Enum() *Plugin_State
func (Plugin_State) EnumDescriptor
func (Plugin_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Plugin_State.Descriptor instead.
func (Plugin_State) Number
func (x Plugin_State) Number() protoreflect.EnumNumber
func (Plugin_State) String
func (x Plugin_State) String() string
func (Plugin_State) Type
func (Plugin_State) Type() protoreflect.EnumType
Point
type Point struct {
// Required. Line number (zero-indexed).
Line int32 `protobuf:"varint,1,opt,name=line,proto3" json:"line,omitempty"`
// Required. Character position within the line (zero-indexed).
Character int32 `protobuf:"varint,2,opt,name=character,proto3" json:"character,omitempty"`
// contains filtered or unexported fields
}
Point within the file (line and character).
func (*Point) Descriptor
Deprecated: Use Point.ProtoReflect.Descriptor instead.
func (*Point) GetCharacter
func (*Point) GetLine
func (*Point) ProtoMessage
func (*Point) ProtoMessage()
func (*Point) ProtoReflect
func (x *Point) ProtoReflect() protoreflect.Message
func (*Point) Reset
func (x *Point) Reset()
func (*Point) String
ProvisioningClient
type ProvisioningClient interface {
// Provisions instance resources for the API Hub.
CreateApiHubInstance(ctx context.Context, in *CreateApiHubInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets details of a single API Hub instance.
GetApiHubInstance(ctx context.Context, in *GetApiHubInstanceRequest, opts ...grpc.CallOption) (*ApiHubInstance, error)
// Looks up an Api Hub instance in a given GCP project. There will always be
// only one Api Hub instance for a GCP project across all locations.
LookupApiHubInstance(ctx context.Context, in *LookupApiHubInstanceRequest, opts ...grpc.CallOption) (*LookupApiHubInstanceResponse, error)
}
ProvisioningClient is the client API for Provisioning service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewProvisioningClient
func NewProvisioningClient(cc grpc.ClientConnInterface) ProvisioningClient
ProvisioningServer
type ProvisioningServer interface {
// Provisions instance resources for the API Hub.
CreateApiHubInstance(context.Context, *CreateApiHubInstanceRequest) (*longrunningpb.Operation, error)
// Gets details of a single API Hub instance.
GetApiHubInstance(context.Context, *GetApiHubInstanceRequest) (*ApiHubInstance, error)
// Looks up an Api Hub instance in a given GCP project. There will always be
// only one Api Hub instance for a GCP project across all locations.
LookupApiHubInstance(context.Context, *LookupApiHubInstanceRequest) (*LookupApiHubInstanceResponse, error)
}
ProvisioningServer is the server API for Provisioning service.
Range
type Range struct {
// Required. Start of the issue.
Start *Point `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"`
// Required. End of the issue.
End *Point `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"`
// contains filtered or unexported fields
}
Object describing where in the file the issue was found.
func (*Range) Descriptor
Deprecated: Use Range.ProtoReflect.Descriptor instead.
func (*Range) GetEnd
func (*Range) GetStart
func (*Range) ProtoMessage
func (*Range) ProtoMessage()
func (*Range) ProtoReflect
func (x *Range) ProtoReflect() protoreflect.Message
func (*Range) Reset
func (x *Range) Reset()
func (*Range) String
RuntimeProjectAttachment
type RuntimeProjectAttachment struct {
// Identifier. The resource name of a runtime project attachment. Format:
// "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Google cloud project name in the format:
// "projects/abc" or "projects/123". As input, project name with either
// project id or number are accepted. As output, this field will contain
// project number.
RuntimeProject string `protobuf:"bytes,2,opt,name=runtime_project,json=runtimeProject,proto3" json:"runtime_project,omitempty"`
// Output only. Create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
func (*RuntimeProjectAttachment) Descriptor
func (*RuntimeProjectAttachment) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeProjectAttachment.ProtoReflect.Descriptor instead.
func (*RuntimeProjectAttachment) GetCreateTime
func (x *RuntimeProjectAttachment) GetCreateTime() *timestamppb.Timestamp
func (*RuntimeProjectAttachment) GetName
func (x *RuntimeProjectAttachment) GetName() string
func (*RuntimeProjectAttachment) GetRuntimeProject
func (x *RuntimeProjectAttachment) GetRuntimeProject() string
func (*RuntimeProjectAttachment) ProtoMessage
func (*RuntimeProjectAttachment) ProtoMessage()
func (*RuntimeProjectAttachment) ProtoReflect
func (x *RuntimeProjectAttachment) ProtoReflect() protoreflect.Message
func (*RuntimeProjectAttachment) Reset
func (x *RuntimeProjectAttachment) Reset()
func (*RuntimeProjectAttachment) String
func (x *RuntimeProjectAttachment) String() string
RuntimeProjectAttachmentServiceClient
type RuntimeProjectAttachmentServiceClient interface {
// Attaches a runtime project to the host project.
CreateRuntimeProjectAttachment(ctx context.Context, in *CreateRuntimeProjectAttachmentRequest, opts ...grpc.CallOption) (*RuntimeProjectAttachment, error)
// Gets a runtime project attachment.
GetRuntimeProjectAttachment(ctx context.Context, in *GetRuntimeProjectAttachmentRequest, opts ...grpc.CallOption) (*RuntimeProjectAttachment, error)
// List runtime projects attached to the host project.
ListRuntimeProjectAttachments(ctx context.Context, in *ListRuntimeProjectAttachmentsRequest, opts ...grpc.CallOption) (*ListRuntimeProjectAttachmentsResponse, error)
// Delete a runtime project attachment in the API Hub. This call will detach
// the runtime project from the host project.
DeleteRuntimeProjectAttachment(ctx context.Context, in *DeleteRuntimeProjectAttachmentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Look up a runtime project attachment. This API can be called in the context
// of any project.
LookupRuntimeProjectAttachment(ctx context.Context, in *LookupRuntimeProjectAttachmentRequest, opts ...grpc.CallOption) (*LookupRuntimeProjectAttachmentResponse, error)
}
RuntimeProjectAttachmentServiceClient is the client API for RuntimeProjectAttachmentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewRuntimeProjectAttachmentServiceClient
func NewRuntimeProjectAttachmentServiceClient(cc grpc.ClientConnInterface) RuntimeProjectAttachmentServiceClient
RuntimeProjectAttachmentServiceServer
type RuntimeProjectAttachmentServiceServer interface {
// Attaches a runtime project to the host project.
CreateRuntimeProjectAttachment(context.Context, *CreateRuntimeProjectAttachmentRequest) (*RuntimeProjectAttachment, error)
// Gets a runtime project attachment.
GetRuntimeProjectAttachment(context.Context, *GetRuntimeProjectAttachmentRequest) (*RuntimeProjectAttachment, error)
// List runtime projects attached to the host project.
ListRuntimeProjectAttachments(context.Context, *ListRuntimeProjectAttachmentsRequest) (*ListRuntimeProjectAttachmentsResponse, error)
// Delete a runtime project attachment in the API Hub. This call will detach
// the runtime project from the host project.
DeleteRuntimeProjectAttachment(context.Context, *DeleteRuntimeProjectAttachmentRequest) (*emptypb.Empty, error)
// Look up a runtime project attachment. This API can be called in the context
// of any project.
LookupRuntimeProjectAttachment(context.Context, *LookupRuntimeProjectAttachmentRequest) (*LookupRuntimeProjectAttachmentResponse, error)
}
RuntimeProjectAttachmentServiceServer is the server API for RuntimeProjectAttachmentService service.
Schema
type Schema struct {
// Output only. The display name of the schema.
// This will map to the name of the schema in the spec.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. The raw value of the schema definition corresponding to the
// schema name in the spec.
RawValue []byte `protobuf:"bytes,2,opt,name=raw_value,json=rawValue,proto3" json:"raw_value,omitempty"`
// contains filtered or unexported fields
}
The schema details derived from the spec. Currently, this entity is supported
for OpenAPI spec only.
For OpenAPI spec, this maps to the schema defined in
the definitions
section for OpenAPI 2.0 version and in
components.schemas
section for OpenAPI 3.0 and 3.1 version.
func (*Schema) Descriptor
Deprecated: Use Schema.ProtoReflect.Descriptor instead.
func (*Schema) GetDisplayName
func (*Schema) GetRawValue
func (*Schema) ProtoMessage
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect
func (x *Schema) ProtoReflect() protoreflect.Message
func (*Schema) Reset
func (x *Schema) Reset()
func (*Schema) String
SearchResourcesRequest
type SearchResourcesRequest struct {
// Required. The resource name of the location which will be of the type
// `projects/{project_id}/locations/{location_id}`. This field is used to
// identify the instance of API-Hub in which resources should be searched.
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// Required. The free text search query. This query can contain keywords which
// could be related to any detail of the API-Hub resources such display names,
// descriptions, attributes etc.
Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// Optional. An expression that filters the list of search results.
//
// A filter expression consists of a field name, a comparison operator,
// and a value for filtering. The value must be a string, a number, or a
// boolean. The comparison operator must be `=`. Filters are not case
// sensitive.
//
// The following field names are eligible for filtering:
// - `resource_type` - The type of resource in the search results.
// Must be one of the following: `Api`, `ApiOperation`, `Deployment`,
// `Definition`, `Spec` or `Version`. This field can only be specified once
// in the filter.
//
// Here are is an example:
//
// - `resource_type = Api` - The resource_type is _Api_.
Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of search results to return. The service may
// return fewer than this value. If unspecified at most 10 search results will
// be returned. If value is negative then `INVALID_ARGUMENT` error is
// returned. The maximum value is 25; values above 25 will be coerced to 25.
// While paginating, you can specify a new page size parameter for each page
// of search results to be listed.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous
// [SearchResources][SearchResources]
// call. Specify this parameter to retrieve the next page of transactions.
//
// When paginating, you must specify the `page_token` parameter and all the
// other parameters except
// [page_size][google.cloud.apihub.v1.SearchResourcesRequest.page_size]
// should be specified with the same value which was used in the previous
// call. If the other fields are set with a different value than the previous
// call then `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method's request.
func (*SearchResourcesRequest) Descriptor
func (*SearchResourcesRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchResourcesRequest.ProtoReflect.Descriptor instead.
func (*SearchResourcesRequest) GetFilter
func (x *SearchResourcesRequest) GetFilter() string
func (*SearchResourcesRequest) GetLocation
func (x *SearchResourcesRequest) GetLocation() string
func (*SearchResourcesRequest) GetPageSize
func (x *SearchResourcesRequest) GetPageSize() int32
func (*SearchResourcesRequest) GetPageToken
func (x *SearchResourcesRequest) GetPageToken() string
func (*SearchResourcesRequest) GetQuery
func (x *SearchResourcesRequest) GetQuery() string
func (*SearchResourcesRequest) ProtoMessage
func (*SearchResourcesRequest) ProtoMessage()
func (*SearchResourcesRequest) ProtoReflect
func (x *SearchResourcesRequest) ProtoReflect() protoreflect.Message
func (*SearchResourcesRequest) Reset
func (x *SearchResourcesRequest) Reset()
func (*SearchResourcesRequest) String
func (x *SearchResourcesRequest) String() string
SearchResourcesResponse
type SearchResourcesResponse struct {
// List of search results according to the filter and search query specified.
// The order of search results represents the ranking.
SearchResults []*SearchResult `protobuf:"bytes,1,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// Pass this token in the
// [SearchResourcesRequest][google.cloud.apihub.v1.SearchResourcesRequest]
// to continue to list results. If all results have been returned, this field
// is an empty string or not present in the response.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
Response for the [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method.
func (*SearchResourcesResponse) Descriptor
func (*SearchResourcesResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchResourcesResponse.ProtoReflect.Descriptor instead.
func (*SearchResourcesResponse) GetNextPageToken
func (x *SearchResourcesResponse) GetNextPageToken() string
func (*SearchResourcesResponse) GetSearchResults
func (x *SearchResourcesResponse) GetSearchResults() []*SearchResult
func (*SearchResourcesResponse) ProtoMessage
func (*SearchResourcesResponse) ProtoMessage()
func (*SearchResourcesResponse) ProtoReflect
func (x *SearchResourcesResponse) ProtoReflect() protoreflect.Message
func (*SearchResourcesResponse) Reset
func (x *SearchResourcesResponse) Reset()
func (*SearchResourcesResponse) String
func (x *SearchResourcesResponse) String() string
SearchResult
type SearchResult struct {
// This represents the ApiHubResource.
// Note: Only selected fields of the resources are populated in response.
Resource *ApiHubResource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// contains filtered or unexported fields
}
Represents the search results.
func (*SearchResult) Descriptor
func (*SearchResult) Descriptor() ([]byte, []int)
Deprecated: Use SearchResult.ProtoReflect.Descriptor instead.
func (*SearchResult) GetResource
func (x *SearchResult) GetResource() *ApiHubResource
func (*SearchResult) ProtoMessage
func (*SearchResult) ProtoMessage()
func (*SearchResult) ProtoReflect
func (x *SearchResult) ProtoReflect() protoreflect.Message
func (*SearchResult) Reset
func (x *SearchResult) Reset()
func (*SearchResult) String
func (x *SearchResult) String() string
Severity
type Severity int32
Severity of the issue.
Severity_SEVERITY_UNSPECIFIED, Severity_SEVERITY_ERROR, Severity_SEVERITY_WARNING, Severity_SEVERITY_INFO, Severity_SEVERITY_HINT
const (
// Severity unspecified.
Severity_SEVERITY_UNSPECIFIED Severity = 0
// Severity error.
Severity_SEVERITY_ERROR Severity = 1
// Severity warning.
Severity_SEVERITY_WARNING Severity = 2
// Severity info.
Severity_SEVERITY_INFO Severity = 3
// Severity hint.
Severity_SEVERITY_HINT Severity = 4
)
func (Severity) Descriptor
func (Severity) Descriptor() protoreflect.EnumDescriptor
func (Severity) Enum
func (Severity) EnumDescriptor
Deprecated: Use Severity.Descriptor instead.
func (Severity) Number
func (x Severity) Number() protoreflect.EnumNumber
func (Severity) String
func (Severity) Type
func (Severity) Type() protoreflect.EnumType
Spec
type Spec struct {
// Identifier. The name of the spec.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the spec.
// This can contain the file name of the spec.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The type of spec.
// The value should be one of the allowed values defined for
// `projects/{project}/locations/{location}/attributes/system-spec-type`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API.
//
// Note, this field is mandatory if content is provided.
SpecType *AttributeValues `protobuf:"bytes,3,opt,name=spec_type,json=specType,proto3" json:"spec_type,omitempty"`
// Optional. Input only. The contents of the uploaded spec.
Contents *SpecContents `protobuf:"bytes,4,opt,name=contents,proto3" json:"contents,omitempty"`
// Output only. Details parsed from the spec.
Details *SpecDetails `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"`
// Optional. The URI of the spec source in case file is uploaded
// from an external version control system.
SourceUri string `protobuf:"bytes,6,opt,name=source_uri,json=sourceUri,proto3" json:"source_uri,omitempty"`
// Output only. The time at which the spec was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the spec was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The lint response for the spec.
LintResponse *LintResponse `protobuf:"bytes,9,opt,name=lint_response,json=lintResponse,proto3" json:"lint_response,omitempty"`
// Optional. The list of user defined attributes associated with the spec.
// The key is the attribute name. It will be of the format:
// `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,10,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The documentation of the spec.
// For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI
// spec.
Documentation *Documentation `protobuf:"bytes,11,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Optional. Input only. Enum specifying the parsing mode for OpenAPI
// Specification (OAS) parsing.
ParsingMode Spec_ParsingMode `protobuf:"varint,12,opt,name=parsing_mode,json=parsingMode,proto3,enum=google.cloud.apihub.v1.Spec_ParsingMode" json:"parsing_mode,omitempty"`
// contains filtered or unexported fields
}
Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
func (*Spec) Descriptor
Deprecated: Use Spec.ProtoReflect.Descriptor instead.
func (*Spec) GetAttributes
func (x *Spec) GetAttributes() map[string]*AttributeValues
func (*Spec) GetContents
func (x *Spec) GetContents() *SpecContents
func (*Spec) GetCreateTime
func (x *Spec) GetCreateTime() *timestamppb.Timestamp
func (*Spec) GetDetails
func (x *Spec) GetDetails() *SpecDetails
func (*Spec) GetDisplayName
func (*Spec) GetDocumentation
func (x *Spec) GetDocumentation() *Documentation
func (*Spec) GetLintResponse
func (x *Spec) GetLintResponse() *LintResponse
func (*Spec) GetName
func (*Spec) GetParsingMode
func (x *Spec) GetParsingMode() Spec_ParsingMode
func (*Spec) GetSourceUri
func (*Spec) GetSpecType
func (x *Spec) GetSpecType() *AttributeValues
func (*Spec) GetUpdateTime
func (x *Spec) GetUpdateTime() *timestamppb.Timestamp
func (*Spec) ProtoMessage
func (*Spec) ProtoMessage()
func (*Spec) ProtoReflect
func (x *Spec) ProtoReflect() protoreflect.Message
func (*Spec) Reset
func (x *Spec) Reset()
func (*Spec) String
SpecContents
type SpecContents struct {
// Required. The contents of the spec.
Contents []byte `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
// Required. The mime type of the content for example application/json,
// application/yaml, application/wsdl etc.
MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}
The spec contents.
func (*SpecContents) Descriptor
func (*SpecContents) Descriptor() ([]byte, []int)
Deprecated: Use SpecContents.ProtoReflect.Descriptor instead.
func (*SpecContents) GetContents
func (x *SpecContents) GetContents() []byte
func (*SpecContents) GetMimeType
func (x *SpecContents) GetMimeType() string
func (*SpecContents) ProtoMessage
func (*SpecContents) ProtoMessage()
func (*SpecContents) ProtoReflect
func (x *SpecContents) ProtoReflect() protoreflect.Message
func (*SpecContents) Reset
func (x *SpecContents) Reset()
func (*SpecContents) String
func (x *SpecContents) String() string
SpecDetails
type SpecDetails struct {
// Types that are assignable to Details:
//
// *SpecDetails_OpenApiSpecDetails
Details isSpecDetails_Details `protobuf_oneof:"details"`
// Output only. The description of the spec.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
SpecDetails contains the details parsed from supported spec types.
func (*SpecDetails) Descriptor
func (*SpecDetails) Descriptor() ([]byte, []int)
Deprecated: Use SpecDetails.ProtoReflect.Descriptor instead.
func (*SpecDetails) GetDescription
func (x *SpecDetails) GetDescription() string
func (*SpecDetails) GetDetails
func (m *SpecDetails) GetDetails() isSpecDetails_Details
func (*SpecDetails) GetOpenApiSpecDetails
func (x *SpecDetails) GetOpenApiSpecDetails() *OpenApiSpecDetails
func (*SpecDetails) ProtoMessage
func (*SpecDetails) ProtoMessage()
func (*SpecDetails) ProtoReflect
func (x *SpecDetails) ProtoReflect() protoreflect.Message
func (*SpecDetails) Reset
func (x *SpecDetails) Reset()
func (*SpecDetails) String
func (x *SpecDetails) String() string
SpecDetails_OpenApiSpecDetails
type SpecDetails_OpenApiSpecDetails struct {
// Output only. Additional details apart from `OperationDetails` parsed from
// an OpenAPI spec. The OperationDetails parsed from the spec can be
// obtained by using
// [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations]
// method.
OpenApiSpecDetails *OpenApiSpecDetails `protobuf:"bytes,2,opt,name=open_api_spec_details,json=openApiSpecDetails,proto3,oneof"`
}
Spec_ParsingMode
type Spec_ParsingMode int32
Specifies the parsing mode for API specifications during creation and update.
RELAXED
: Parsing errors in the specification content do not fail the API call.STRICT
: Parsing errors in the specification content result in failure of the API call. If not specified, defaults toRELAXED
.
Spec_PARSING_MODE_UNSPECIFIED, Spec_RELAXED, Spec_STRICT
const (
// Defaults to `RELAXED`.
Spec_PARSING_MODE_UNSPECIFIED Spec_ParsingMode = 0
// Parsing of the Spec on create and update is relaxed, meaning that
// parsing errors the spec contents will not fail the API call.
Spec_RELAXED Spec_ParsingMode = 1
// Parsing of the Spec on create and update is strict, meaning that
// parsing errors in the spec contents will fail the API call.
Spec_STRICT Spec_ParsingMode = 2
)
func (Spec_ParsingMode) Descriptor
func (Spec_ParsingMode) Descriptor() protoreflect.EnumDescriptor
func (Spec_ParsingMode) Enum
func (x Spec_ParsingMode) Enum() *Spec_ParsingMode
func (Spec_ParsingMode) EnumDescriptor
func (Spec_ParsingMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use Spec_ParsingMode.Descriptor instead.
func (Spec_ParsingMode) Number
func (x Spec_ParsingMode) Number() protoreflect.EnumNumber
func (Spec_ParsingMode) String
func (x Spec_ParsingMode) String() string
func (Spec_ParsingMode) Type
func (Spec_ParsingMode) Type() protoreflect.EnumType
StyleGuide
type StyleGuide struct {
// Identifier. The name of the style guide.
//
// Format:
// `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Target linter for the style guide.
Linter Linter `protobuf:"varint,2,opt,name=linter,proto3,enum=google.cloud.apihub.v1.Linter" json:"linter,omitempty"`
// Required. Input only. The contents of the uploaded style guide.
Contents *StyleGuideContents `protobuf:"bytes,3,opt,name=contents,proto3" json:"contents,omitempty"`
// contains filtered or unexported fields
}
Represents a singleton style guide resource to be used for linting Open API specs.
func (*StyleGuide) Descriptor
func (*StyleGuide) Descriptor() ([]byte, []int)
Deprecated: Use StyleGuide.ProtoReflect.Descriptor instead.
func (*StyleGuide) GetContents
func (x *StyleGuide) GetContents() *StyleGuideContents
func (*StyleGuide) GetLinter
func (x *StyleGuide) GetLinter() Linter
func (*StyleGuide) GetName
func (x *StyleGuide) GetName() string
func (*StyleGuide) ProtoMessage
func (*StyleGuide) ProtoMessage()
func (*StyleGuide) ProtoReflect
func (x *StyleGuide) ProtoReflect() protoreflect.Message
func (*StyleGuide) Reset
func (x *StyleGuide) Reset()
func (*StyleGuide) String
func (x *StyleGuide) String() string
StyleGuideContents
type StyleGuideContents struct {
// Required. The contents of the style guide.
Contents []byte `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
// Required. The mime type of the content.
MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}
The style guide contents.
func (*StyleGuideContents) Descriptor
func (*StyleGuideContents) Descriptor() ([]byte, []int)
Deprecated: Use StyleGuideContents.ProtoReflect.Descriptor instead.
func (*StyleGuideContents) GetContents
func (x *StyleGuideContents) GetContents() []byte
func (*StyleGuideContents) GetMimeType
func (x *StyleGuideContents) GetMimeType() string
func (*StyleGuideContents) ProtoMessage
func (*StyleGuideContents) ProtoMessage()
func (*StyleGuideContents) ProtoReflect
func (x *StyleGuideContents) ProtoReflect() protoreflect.Message
func (*StyleGuideContents) Reset
func (x *StyleGuideContents) Reset()
func (*StyleGuideContents) String
func (x *StyleGuideContents) String() string
UnimplementedApiHubDependenciesServer
type UnimplementedApiHubDependenciesServer struct {
}
UnimplementedApiHubDependenciesServer can be embedded to have forward compatible implementations.
func (*UnimplementedApiHubDependenciesServer) CreateDependency
func (*UnimplementedApiHubDependenciesServer) CreateDependency(context.Context, *CreateDependencyRequest) (*Dependency, error)
func (*UnimplementedApiHubDependenciesServer) DeleteDependency
func (*UnimplementedApiHubDependenciesServer) DeleteDependency(context.Context, *DeleteDependencyRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubDependenciesServer) GetDependency
func (*UnimplementedApiHubDependenciesServer) GetDependency(context.Context, *GetDependencyRequest) (*Dependency, error)
func (*UnimplementedApiHubDependenciesServer) ListDependencies
func (*UnimplementedApiHubDependenciesServer) ListDependencies(context.Context, *ListDependenciesRequest) (*ListDependenciesResponse, error)
func (*UnimplementedApiHubDependenciesServer) UpdateDependency
func (*UnimplementedApiHubDependenciesServer) UpdateDependency(context.Context, *UpdateDependencyRequest) (*Dependency, error)
UnimplementedApiHubPluginServer
type UnimplementedApiHubPluginServer struct {
}
UnimplementedApiHubPluginServer can be embedded to have forward compatible implementations.
func (*UnimplementedApiHubPluginServer) DisablePlugin
func (*UnimplementedApiHubPluginServer) DisablePlugin(context.Context, *DisablePluginRequest) (*Plugin, error)
func (*UnimplementedApiHubPluginServer) EnablePlugin
func (*UnimplementedApiHubPluginServer) EnablePlugin(context.Context, *EnablePluginRequest) (*Plugin, error)
func (*UnimplementedApiHubPluginServer) GetPlugin
func (*UnimplementedApiHubPluginServer) GetPlugin(context.Context, *GetPluginRequest) (*Plugin, error)
UnimplementedApiHubServer
type UnimplementedApiHubServer struct {
}
UnimplementedApiHubServer can be embedded to have forward compatible implementations.
func (*UnimplementedApiHubServer) CreateApi
func (*UnimplementedApiHubServer) CreateApi(context.Context, *CreateApiRequest) (*Api, error)
func (*UnimplementedApiHubServer) CreateAttribute
func (*UnimplementedApiHubServer) CreateAttribute(context.Context, *CreateAttributeRequest) (*Attribute, error)
func (*UnimplementedApiHubServer) CreateDeployment
func (*UnimplementedApiHubServer) CreateDeployment(context.Context, *CreateDeploymentRequest) (*Deployment, error)
func (*UnimplementedApiHubServer) CreateExternalApi
func (*UnimplementedApiHubServer) CreateExternalApi(context.Context, *CreateExternalApiRequest) (*ExternalApi, error)
func (*UnimplementedApiHubServer) CreateSpec
func (*UnimplementedApiHubServer) CreateSpec(context.Context, *CreateSpecRequest) (*Spec, error)
func (*UnimplementedApiHubServer) CreateVersion
func (*UnimplementedApiHubServer) CreateVersion(context.Context, *CreateVersionRequest) (*Version, error)
func (*UnimplementedApiHubServer) DeleteApi
func (*UnimplementedApiHubServer) DeleteApi(context.Context, *DeleteApiRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) DeleteAttribute
func (*UnimplementedApiHubServer) DeleteAttribute(context.Context, *DeleteAttributeRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) DeleteDeployment
func (*UnimplementedApiHubServer) DeleteDeployment(context.Context, *DeleteDeploymentRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) DeleteExternalApi
func (*UnimplementedApiHubServer) DeleteExternalApi(context.Context, *DeleteExternalApiRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) DeleteSpec
func (*UnimplementedApiHubServer) DeleteSpec(context.Context, *DeleteSpecRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) DeleteVersion
func (*UnimplementedApiHubServer) DeleteVersion(context.Context, *DeleteVersionRequest) (*emptypb.Empty, error)
func (*UnimplementedApiHubServer) GetApi
func (*UnimplementedApiHubServer) GetApi(context.Context, *GetApiRequest) (*Api, error)
func (*UnimplementedApiHubServer) GetApiOperation
func (*UnimplementedApiHubServer) GetApiOperation(context.Context, *GetApiOperationRequest) (*ApiOperation, error)
func (*UnimplementedApiHubServer) GetAttribute
func (*UnimplementedApiHubServer) GetAttribute(context.Context, *GetAttributeRequest) (*Attribute, error)
func (*UnimplementedApiHubServer) GetDefinition
func (*UnimplementedApiHubServer) GetDefinition(context.Context, *GetDefinitionRequest) (*Definition, error)
func (*UnimplementedApiHubServer) GetDeployment
func (*UnimplementedApiHubServer) GetDeployment(context.Context, *GetDeploymentRequest) (*Deployment, error)
func (*UnimplementedApiHubServer) GetExternalApi
func (*UnimplementedApiHubServer) GetExternalApi(context.Context, *GetExternalApiRequest) (*ExternalApi, error)
func (*UnimplementedApiHubServer) GetSpec
func (*UnimplementedApiHubServer) GetSpec(context.Context, *GetSpecRequest) (*Spec, error)
func (*UnimplementedApiHubServer) GetSpecContents
func (*UnimplementedApiHubServer) GetSpecContents(context.Context, *GetSpecContentsRequest) (*SpecContents, error)
func (*UnimplementedApiHubServer) GetVersion
func (*UnimplementedApiHubServer) GetVersion(context.Context, *GetVersionRequest) (*Version, error)
func (*UnimplementedApiHubServer) ListApiOperations
func (*UnimplementedApiHubServer) ListApiOperations(context.Context, *ListApiOperationsRequest) (*ListApiOperationsResponse, error)
func (*UnimplementedApiHubServer) ListApis
func (*UnimplementedApiHubServer) ListApis(context.Context, *ListApisRequest) (*ListApisResponse, error)
func (*UnimplementedApiHubServer) ListAttributes
func (*UnimplementedApiHubServer) ListAttributes(context.Context, *ListAttributesRequest) (*ListAttributesResponse, error)
func (*UnimplementedApiHubServer) ListDeployments
func (*UnimplementedApiHubServer) ListDeployments(context.Context, *ListDeploymentsRequest) (*ListDeploymentsResponse, error)
func (*UnimplementedApiHubServer) ListExternalApis
func (*UnimplementedApiHubServer) ListExternalApis(context.Context, *ListExternalApisRequest) (*ListExternalApisResponse, error)
func (*UnimplementedApiHubServer) ListSpecs
func (*UnimplementedApiHubServer) ListSpecs(context.Context, *ListSpecsRequest) (*ListSpecsResponse, error)
func (*UnimplementedApiHubServer) ListVersions
func (*UnimplementedApiHubServer) ListVersions(context.Context, *ListVersionsRequest) (*ListVersionsResponse, error)
func (*UnimplementedApiHubServer) SearchResources
func (*UnimplementedApiHubServer) SearchResources(context.Context, *SearchResourcesRequest) (*SearchResourcesResponse, error)
func (*UnimplementedApiHubServer) UpdateApi
func (*UnimplementedApiHubServer) UpdateApi(context.Context, *UpdateApiRequest) (*Api, error)
func (*UnimplementedApiHubServer) UpdateAttribute
func (*UnimplementedApiHubServer) UpdateAttribute(context.Context, *UpdateAttributeRequest) (*Attribute, error)
func (*UnimplementedApiHubServer) UpdateDeployment
func (*UnimplementedApiHubServer) UpdateDeployment(context.Context, *UpdateDeploymentRequest) (*Deployment, error)
func (*UnimplementedApiHubServer) UpdateExternalApi
func (*UnimplementedApiHubServer) UpdateExternalApi(context.Context, *UpdateExternalApiRequest) (*ExternalApi, error)
func (*UnimplementedApiHubServer) UpdateSpec
func (*UnimplementedApiHubServer) UpdateSpec(context.Context, *UpdateSpecRequest) (*Spec, error)
func (*UnimplementedApiHubServer) UpdateVersion
func (*UnimplementedApiHubServer) UpdateVersion(context.Context, *UpdateVersionRequest) (*Version, error)
UnimplementedHostProjectRegistrationServiceServer
type UnimplementedHostProjectRegistrationServiceServer struct {
}
UnimplementedHostProjectRegistrationServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedHostProjectRegistrationServiceServer) CreateHostProjectRegistration
func (*UnimplementedHostProjectRegistrationServiceServer) CreateHostProjectRegistration(context.Context, *CreateHostProjectRegistrationRequest) (*HostProjectRegistration, error)
func (*UnimplementedHostProjectRegistrationServiceServer) GetHostProjectRegistration
func (*UnimplementedHostProjectRegistrationServiceServer) GetHostProjectRegistration(context.Context, *GetHostProjectRegistrationRequest) (*HostProjectRegistration, error)
func (*UnimplementedHostProjectRegistrationServiceServer) ListHostProjectRegistrations
func (*UnimplementedHostProjectRegistrationServiceServer) ListHostProjectRegistrations(context.Context, *ListHostProjectRegistrationsRequest) (*ListHostProjectRegistrationsResponse, error)
UnimplementedLintingServiceServer
type UnimplementedLintingServiceServer struct {
}
UnimplementedLintingServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedLintingServiceServer) GetStyleGuide
func (*UnimplementedLintingServiceServer) GetStyleGuide(context.Context, *GetStyleGuideRequest) (*StyleGuide, error)
func (*UnimplementedLintingServiceServer) GetStyleGuideContents
func (*UnimplementedLintingServiceServer) GetStyleGuideContents(context.Context, *GetStyleGuideContentsRequest) (*StyleGuideContents, error)
func (*UnimplementedLintingServiceServer) LintSpec
func (*UnimplementedLintingServiceServer) LintSpec(context.Context, *LintSpecRequest) (*emptypb.Empty, error)
func (*UnimplementedLintingServiceServer) UpdateStyleGuide
func (*UnimplementedLintingServiceServer) UpdateStyleGuide(context.Context, *UpdateStyleGuideRequest) (*StyleGuide, error)
UnimplementedProvisioningServer
type UnimplementedProvisioningServer struct {
}
UnimplementedProvisioningServer can be embedded to have forward compatible implementations.
func (*UnimplementedProvisioningServer) CreateApiHubInstance
func (*UnimplementedProvisioningServer) CreateApiHubInstance(context.Context, *CreateApiHubInstanceRequest) (*longrunningpb.Operation, error)
func (*UnimplementedProvisioningServer) GetApiHubInstance
func (*UnimplementedProvisioningServer) GetApiHubInstance(context.Context, *GetApiHubInstanceRequest) (*ApiHubInstance, error)
func (*UnimplementedProvisioningServer) LookupApiHubInstance
func (*UnimplementedProvisioningServer) LookupApiHubInstance(context.Context, *LookupApiHubInstanceRequest) (*LookupApiHubInstanceResponse, error)
UnimplementedRuntimeProjectAttachmentServiceServer
type UnimplementedRuntimeProjectAttachmentServiceServer struct {
}
UnimplementedRuntimeProjectAttachmentServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedRuntimeProjectAttachmentServiceServer) CreateRuntimeProjectAttachment
func (*UnimplementedRuntimeProjectAttachmentServiceServer) CreateRuntimeProjectAttachment(context.Context, *CreateRuntimeProjectAttachmentRequest) (*RuntimeProjectAttachment, error)
func (*UnimplementedRuntimeProjectAttachmentServiceServer) DeleteRuntimeProjectAttachment
func (*UnimplementedRuntimeProjectAttachmentServiceServer) DeleteRuntimeProjectAttachment(context.Context, *DeleteRuntimeProjectAttachmentRequest) (*emptypb.Empty, error)
func (*UnimplementedRuntimeProjectAttachmentServiceServer) GetRuntimeProjectAttachment
func (*UnimplementedRuntimeProjectAttachmentServiceServer) GetRuntimeProjectAttachment(context.Context, *GetRuntimeProjectAttachmentRequest) (*RuntimeProjectAttachment, error)
func (*UnimplementedRuntimeProjectAttachmentServiceServer) ListRuntimeProjectAttachments
func (*UnimplementedRuntimeProjectAttachmentServiceServer) ListRuntimeProjectAttachments(context.Context, *ListRuntimeProjectAttachmentsRequest) (*ListRuntimeProjectAttachmentsResponse, error)
func (*UnimplementedRuntimeProjectAttachmentServiceServer) LookupRuntimeProjectAttachment
func (*UnimplementedRuntimeProjectAttachmentServiceServer) LookupRuntimeProjectAttachment(context.Context, *LookupRuntimeProjectAttachmentRequest) (*LookupRuntimeProjectAttachmentResponse, error)
UpdateApiRequest
type UpdateApiRequest struct {
// Required. The API resource to update.
//
// The API resource's `name` field is used to identify the API resource to
// update.
// Format: `projects/{project}/locations/{location}/apis/{api}`
Api *Api `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateApi][google.cloud.apihub.v1.ApiHub.UpdateApi] method's request.
func (*UpdateApiRequest) Descriptor
func (*UpdateApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateApiRequest.ProtoReflect.Descriptor instead.
func (*UpdateApiRequest) GetApi
func (x *UpdateApiRequest) GetApi() *Api
func (*UpdateApiRequest) GetUpdateMask
func (x *UpdateApiRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateApiRequest) ProtoMessage
func (*UpdateApiRequest) ProtoMessage()
func (*UpdateApiRequest) ProtoReflect
func (x *UpdateApiRequest) ProtoReflect() protoreflect.Message
func (*UpdateApiRequest) Reset
func (x *UpdateApiRequest) Reset()
func (*UpdateApiRequest) String
func (x *UpdateApiRequest) String() string
UpdateAttributeRequest
type UpdateAttributeRequest struct {
// Required. The attribute to update.
//
// The attribute's `name` field is used to identify the attribute to update.
// Format:
// `projects/{project}/locations/{location}/attributes/{attribute}`
Attribute *Attribute `protobuf:"bytes,1,opt,name=attribute,proto3" json:"attribute,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method's request.
func (*UpdateAttributeRequest) Descriptor
func (*UpdateAttributeRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAttributeRequest.ProtoReflect.Descriptor instead.
func (*UpdateAttributeRequest) GetAttribute
func (x *UpdateAttributeRequest) GetAttribute() *Attribute
func (*UpdateAttributeRequest) GetUpdateMask
func (x *UpdateAttributeRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateAttributeRequest) ProtoMessage
func (*UpdateAttributeRequest) ProtoMessage()
func (*UpdateAttributeRequest) ProtoReflect
func (x *UpdateAttributeRequest) ProtoReflect() protoreflect.Message
func (*UpdateAttributeRequest) Reset
func (x *UpdateAttributeRequest) Reset()
func (*UpdateAttributeRequest) String
func (x *UpdateAttributeRequest) String() string
UpdateDependencyRequest
type UpdateDependencyRequest struct {
// Required. The dependency resource to update.
//
// The dependency's `name` field is used to identify the dependency to update.
// Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Dependency *Dependency `protobuf:"bytes,1,opt,name=dependency,proto3" json:"dependency,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateDependency][google.cloud.apihub.v1.ApiHubDependencies.UpdateDependency] method's request.
func (*UpdateDependencyRequest) Descriptor
func (*UpdateDependencyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDependencyRequest.ProtoReflect.Descriptor instead.
func (*UpdateDependencyRequest) GetDependency
func (x *UpdateDependencyRequest) GetDependency() *Dependency
func (*UpdateDependencyRequest) GetUpdateMask
func (x *UpdateDependencyRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateDependencyRequest) ProtoMessage
func (*UpdateDependencyRequest) ProtoMessage()
func (*UpdateDependencyRequest) ProtoReflect
func (x *UpdateDependencyRequest) ProtoReflect() protoreflect.Message
func (*UpdateDependencyRequest) Reset
func (x *UpdateDependencyRequest) Reset()
func (*UpdateDependencyRequest) String
func (x *UpdateDependencyRequest) String() string
UpdateDeploymentRequest
type UpdateDeploymentRequest struct {
// Required. The deployment resource to update.
//
// The deployment resource's `name` field is used to identify the deployment
// resource to update.
// Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Deployment *Deployment `protobuf:"bytes,1,opt,name=deployment,proto3" json:"deployment,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateDeployment][google.cloud.apihub.v1.ApiHub.UpdateDeployment] method's request.
func (*UpdateDeploymentRequest) Descriptor
func (*UpdateDeploymentRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDeploymentRequest.ProtoReflect.Descriptor instead.
func (*UpdateDeploymentRequest) GetDeployment
func (x *UpdateDeploymentRequest) GetDeployment() *Deployment
func (*UpdateDeploymentRequest) GetUpdateMask
func (x *UpdateDeploymentRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateDeploymentRequest) ProtoMessage
func (*UpdateDeploymentRequest) ProtoMessage()
func (*UpdateDeploymentRequest) ProtoReflect
func (x *UpdateDeploymentRequest) ProtoReflect() protoreflect.Message
func (*UpdateDeploymentRequest) Reset
func (x *UpdateDeploymentRequest) Reset()
func (*UpdateDeploymentRequest) String
func (x *UpdateDeploymentRequest) String() string
UpdateExternalApiRequest
type UpdateExternalApiRequest struct {
// Required. The External API resource to update.
//
// The External API resource's `name` field is used to identify the External
// API resource to update. Format:
// `projects/{project}/locations/{location}/externalApis/{externalApi}`
ExternalApi *ExternalApi `protobuf:"bytes,1,opt,name=external_api,json=externalApi,proto3" json:"external_api,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateExternalApi][google.cloud.apihub.v1.ApiHub.UpdateExternalApi] method's request.
func (*UpdateExternalApiRequest) Descriptor
func (*UpdateExternalApiRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateExternalApiRequest.ProtoReflect.Descriptor instead.
func (*UpdateExternalApiRequest) GetExternalApi
func (x *UpdateExternalApiRequest) GetExternalApi() *ExternalApi
func (*UpdateExternalApiRequest) GetUpdateMask
func (x *UpdateExternalApiRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateExternalApiRequest) ProtoMessage
func (*UpdateExternalApiRequest) ProtoMessage()
func (*UpdateExternalApiRequest) ProtoReflect
func (x *UpdateExternalApiRequest) ProtoReflect() protoreflect.Message
func (*UpdateExternalApiRequest) Reset
func (x *UpdateExternalApiRequest) Reset()
func (*UpdateExternalApiRequest) String
func (x *UpdateExternalApiRequest) String() string
UpdateSpecRequest
type UpdateSpecRequest struct {
// Required. The spec to update.
//
// The spec's `name` field is used to identify the spec to
// update. Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Spec *Spec `protobuf:"bytes,1,opt,name=spec,proto3" json:"spec,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateSpec][google.cloud.apihub.v1.ApiHub.UpdateSpec] method's request.
func (*UpdateSpecRequest) Descriptor
func (*UpdateSpecRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSpecRequest.ProtoReflect.Descriptor instead.
func (*UpdateSpecRequest) GetSpec
func (x *UpdateSpecRequest) GetSpec() *Spec
func (*UpdateSpecRequest) GetUpdateMask
func (x *UpdateSpecRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateSpecRequest) ProtoMessage
func (*UpdateSpecRequest) ProtoMessage()
func (*UpdateSpecRequest) ProtoReflect
func (x *UpdateSpecRequest) ProtoReflect() protoreflect.Message
func (*UpdateSpecRequest) Reset
func (x *UpdateSpecRequest) Reset()
func (*UpdateSpecRequest) String
func (x *UpdateSpecRequest) String() string
UpdateStyleGuideRequest
type UpdateStyleGuideRequest struct {
// Required. The Style guide resource to update.
StyleGuide *StyleGuide `protobuf:"bytes,1,opt,name=style_guide,json=styleGuide,proto3" json:"style_guide,omitempty"`
// Optional. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateStyleGuide][ApiHub.UpdateStyleGuide] method's request.
func (*UpdateStyleGuideRequest) Descriptor
func (*UpdateStyleGuideRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateStyleGuideRequest.ProtoReflect.Descriptor instead.
func (*UpdateStyleGuideRequest) GetStyleGuide
func (x *UpdateStyleGuideRequest) GetStyleGuide() *StyleGuide
func (*UpdateStyleGuideRequest) GetUpdateMask
func (x *UpdateStyleGuideRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateStyleGuideRequest) ProtoMessage
func (*UpdateStyleGuideRequest) ProtoMessage()
func (*UpdateStyleGuideRequest) ProtoReflect
func (x *UpdateStyleGuideRequest) ProtoReflect() protoreflect.Message
func (*UpdateStyleGuideRequest) Reset
func (x *UpdateStyleGuideRequest) Reset()
func (*UpdateStyleGuideRequest) String
func (x *UpdateStyleGuideRequest) String() string
UpdateVersionRequest
type UpdateVersionRequest struct {
// Required. The API version to update.
//
// The version's `name` field is used to identify the API version to update.
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Version *Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
// Required. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
The [UpdateVersion][google.cloud.apihub.v1.ApiHub.UpdateVersion] method's request.
func (*UpdateVersionRequest) Descriptor
func (*UpdateVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateVersionRequest.ProtoReflect.Descriptor instead.
func (*UpdateVersionRequest) GetUpdateMask
func (x *UpdateVersionRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateVersionRequest) GetVersion
func (x *UpdateVersionRequest) GetVersion() *Version
func (*UpdateVersionRequest) ProtoMessage
func (*UpdateVersionRequest) ProtoMessage()
func (*UpdateVersionRequest) ProtoReflect
func (x *UpdateVersionRequest) ProtoReflect() protoreflect.Message
func (*UpdateVersionRequest) Reset
func (x *UpdateVersionRequest) Reset()
func (*UpdateVersionRequest) String
func (x *UpdateVersionRequest) String() string
Version
type Version struct {
// Identifier. The name of the version.
//
// Format:
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the version.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the version.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The documentation of the version.
Documentation *Documentation `protobuf:"bytes,4,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Output only. The specs associated with this version.
// Note that an API version can be associated with multiple specs.
// Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Specs []string `protobuf:"bytes,5,rep,name=specs,proto3" json:"specs,omitempty"`
// Output only. The operations contained in the API version.
// These operations will be added to the version when a new spec is
// added or when an existing spec is updated. Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
ApiOperations []string `protobuf:"bytes,6,rep,name=api_operations,json=apiOperations,proto3" json:"api_operations,omitempty"`
// Output only. The definitions contained in the API version.
// These definitions will be added to the version when a new spec is
// added or when an existing spec is updated. Format is
// `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
Definitions []string `protobuf:"bytes,7,rep,name=definitions,proto3" json:"definitions,omitempty"`
// Optional. The deployments linked to this API version.
// Note: A particular API version could be deployed to multiple deployments
// (for dev deployment, UAT deployment, etc)
// Format is
// `projects/{project}/locations/{location}/deployments/{deployment}`
Deployments []string `protobuf:"bytes,8,rep,name=deployments,proto3" json:"deployments,omitempty"`
// Output only. The time at which the version was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the version was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The lifecycle of the API version.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-lifecycle`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Lifecycle *AttributeValues `protobuf:"bytes,11,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// Optional. The compliance associated with the API version.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-compliance`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Compliance *AttributeValues `protobuf:"bytes,12,opt,name=compliance,proto3" json:"compliance,omitempty"`
// Optional. The accreditations associated with the API version.
// This maps to the following system defined attribute:
// `projects/{project}/locations/{location}/attributes/system-accreditation`
// attribute.
// The number of values for this attribute will be based on the
// cardinality of the attribute. The same can be retrieved via GetAttribute
// API. All values should be from the list of allowed values defined for the
// attribute.
Accreditation *AttributeValues `protobuf:"bytes,13,opt,name=accreditation,proto3" json:"accreditation,omitempty"`
// Optional. The list of user defined attributes associated with the Version
// resource. The key is the attribute name. It will be of the format:
// `projects/{project}/locations/{location}/attributes/{attribute}`.
// The value is the attribute values associated with the resource.
Attributes map[string]*AttributeValues `protobuf:"bytes,14,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The selected deployment for a Version resource.
// This can be used when special handling is needed on client side for a
// particular deployment linked to the version.
// Format is
// `projects/{project}/locations/{location}/deployments/{deployment}`
SelectedDeployment string `protobuf:"bytes,16,opt,name=selected_deployment,json=selectedDeployment,proto3" json:"selected_deployment,omitempty"`
// contains filtered or unexported fields
}
Represents a version of the API resource in API hub. This is also referred to as the API version.
func (*Version) Descriptor
Deprecated: Use Version.ProtoReflect.Descriptor instead.
func (*Version) GetAccreditation
func (x *Version) GetAccreditation() *AttributeValues
func (*Version) GetApiOperations
func (*Version) GetAttributes
func (x *Version) GetAttributes() map[string]*AttributeValues
func (*Version) GetCompliance
func (x *Version) GetCompliance() *AttributeValues
func (*Version) GetCreateTime
func (x *Version) GetCreateTime() *timestamppb.Timestamp
func (*Version) GetDefinitions
func (*Version) GetDeployments
func (*Version) GetDescription
func (*Version) GetDisplayName
func (*Version) GetDocumentation
func (x *Version) GetDocumentation() *Documentation
func (*Version) GetLifecycle
func (x *Version) GetLifecycle() *AttributeValues
func (*Version) GetName
func (*Version) GetSelectedDeployment
func (*Version) GetSpecs
func (*Version) GetUpdateTime
func (x *Version) GetUpdateTime() *timestamppb.Timestamp
func (*Version) ProtoMessage
func (*Version) ProtoMessage()
func (*Version) ProtoReflect
func (x *Version) ProtoReflect() protoreflect.Message
func (*Version) Reset
func (x *Version) Reset()