apigeeregistrydata

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package apigeeregistrydata provides Apigee Registry type definitions for CloudEvent data payloads.

Supported CloudEvent Types

  • google.cloud.apigeeregistry.instance.v1.created
  • google.cloud.apigeeregistry.instance.v1.deleted
  • google.cloud.apigeeregistry.api.v1.created
  • google.cloud.apigeeregistry.api.v1.updated
  • google.cloud.apigeeregistry.api.v1.deleted
  • google.cloud.apigeeregistry.apiVersion.v1.created
  • google.cloud.apigeeregistry.apiVersion.v1.updated
  • google.cloud.apigeeregistry.apiVersion.v1.deleted
  • google.cloud.apigeeregistry.apiSpec.v1.created
  • google.cloud.apigeeregistry.apiSpec.v1.updated
  • google.cloud.apigeeregistry.apiSpec.v1.deleted
  • google.cloud.apigeeregistry.apiDeployment.v1.created
  • google.cloud.apigeeregistry.apiDeployment.v1.updated
  • google.cloud.apigeeregistry.apiDeployment.v1.deleted

Index

Constants

This section is empty.

Variables

View Source 
var (
	Instance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "INACTIVE",
		2: "CREATING",
		3: "ACTIVE",
		4: "UPDATING",
		5: "DELETING",
		6: "FAILED",
	}
	Instance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"INACTIVE":          1,
		"CREATING":          2,
		"ACTIVE":            3,
		"UPDATING":          4,
		"DELETING":          5,
		"FAILED":            6,
	}
)

Enum value maps for Instance_State.

View Source 
var File_cloud_apigeeregistry_v1_data_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Api 

type Api struct {

	// Resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-meaningful name.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Last update timestamp.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// A user-definable description of the availability of this service.
	// Format: free-form, but we expect single words that describe availability,
	// e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
	Availability string `protobuf:"bytes,6,opt,name=availability,proto3" json:"availability,omitempty"`
	// The recommended version of the API.
	// Format:
	// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
	RecommendedVersion string `protobuf:"bytes,7,opt,name=recommended_version,json=recommendedVersion,proto3" json:"recommended_version,omitempty"`
	// The recommended deployment of the API.
	// Format:
	// `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`
	RecommendedDeployment string `protobuf:"bytes,8,opt,name=recommended_deployment,json=recommendedDeployment,proto3" json:"recommended_deployment,omitempty"`
	// Labels attach identifying metadata to resources. Identifying metadata can
	// be used to filter list operations.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores, and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one resource (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with
	// `apigeeregistry.googleapis.com/` and cannot be changed.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Annotations attach non-identifying metadata to resources.
	//
	// Annotation keys and values are less restricted than those of labels, but
	// should be generally used for small values of broad interest. Larger, topic-
	// specific metadata should be stored in Artifacts.
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

A top-level description of an API. Produced by producers and are commitments to provide services.

func (*Api) Descriptor deprecated 

func (*Api) Descriptor() ([]byte, []int)

Deprecated: Use Api.ProtoReflect.Descriptor instead.

func (*Api) GetAnnotations 

func (x *Api) GetAnnotations() map[string]string

func (*Api) GetAvailability 

func (x *Api) GetAvailability() string

func (*Api) GetCreateTime 

func (x *Api) GetCreateTime() *timestamppb.Timestamp

func (*Api) GetDescription 

func (x *Api) GetDescription() string

func (*Api) GetDisplayName 

func (x *Api) GetDisplayName() string

func (*Api) GetLabels 

func (x *Api) GetLabels() map[string]string

func (*Api) GetName 

func (x *Api) GetName() string

func (*Api) GetRecommendedDeployment 

func (x *Api) GetRecommendedDeployment() string

func (*Api) GetRecommendedVersion 

func (x *Api) GetRecommendedVersion() string

func (*Api) GetUpdateTime 

func (x *Api) GetUpdateTime() *timestamppb.Timestamp

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 

func (x *Api) String() string

type ApiDeployment 

type ApiDeployment struct {

	// Resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-meaningful name.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Immutable. The revision ID of the deployment.
	// A new revision is committed whenever the deployment contents are changed.
	// The format is an 8-character hexadecimal string.
	RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// Output only. Creation timestamp; when the deployment resource was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Revision creation timestamp; when the represented revision was
	// created.
	RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
	// Output only. Last update timestamp: when the represented revision was last
	// modified.
	RevisionUpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=revision_update_time,json=revisionUpdateTime,proto3" json:"revision_update_time,omitempty"`
	// The full resource name (including revision ID) of the spec of the API being
	// served by the deployment. Changes to this value will update the revision.
	// Format: `apis/{api}/deployments/{deployment}`
	ApiSpecRevision string `protobuf:"bytes,8,opt,name=api_spec_revision,json=apiSpecRevision,proto3" json:"api_spec_revision,omitempty"`
	// The address where the deployment is serving. Changes to this value will
	// update the revision.
	EndpointUri string `protobuf:"bytes,9,opt,name=endpoint_uri,json=endpointUri,proto3" json:"endpoint_uri,omitempty"`
	// The address of the external channel of the API (e.g., the Developer
	// Portal). Changes to this value will not affect the revision.
	ExternalChannelUri string `protobuf:"bytes,10,opt,name=external_channel_uri,json=externalChannelUri,proto3" json:"external_channel_uri,omitempty"`
	// Text briefly identifying the intended audience of the API. Changes to this
	// value will not affect the revision.
	IntendedAudience string `protobuf:"bytes,11,opt,name=intended_audience,json=intendedAudience,proto3" json:"intended_audience,omitempty"`
	// Text briefly describing how to access the endpoint. Changes to this value
	// will not affect the revision.
	AccessGuidance string `protobuf:"bytes,12,opt,name=access_guidance,json=accessGuidance,proto3" json:"access_guidance,omitempty"`
	// Labels attach identifying metadata to resources. Identifying metadata can
	// be used to filter list operations.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one resource (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with
	// `apigeeregistry.googleapis.com/` and cannot be changed.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Annotations attach non-identifying metadata to resources.
	//
	// Annotation keys and values are less restricted than those of labels, but
	// should be generally used for small values of broad interest. Larger, topic-
	// specific metadata should be stored in Artifacts.
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

func (*ApiDeployment) Descriptor deprecated 

func (*ApiDeployment) Descriptor() ([]byte, []int)

Deprecated: Use ApiDeployment.ProtoReflect.Descriptor instead.

func (*ApiDeployment) GetAccessGuidance 

func (x *ApiDeployment) GetAccessGuidance() string

func (*ApiDeployment) GetAnnotations 

func (x *ApiDeployment) GetAnnotations() map[string]string

func (*ApiDeployment) GetApiSpecRevision 

func (x *ApiDeployment) GetApiSpecRevision() string

func (*ApiDeployment) GetCreateTime 

func (x *ApiDeployment) GetCreateTime() *timestamppb.Timestamp

func (*ApiDeployment) GetDescription 

func (x *ApiDeployment) GetDescription() string

func (*ApiDeployment) GetDisplayName 

func (x *ApiDeployment) GetDisplayName() string

func (*ApiDeployment) GetEndpointUri 

func (x *ApiDeployment) GetEndpointUri() string

func (*ApiDeployment) GetExternalChannelUri 

func (x *ApiDeployment) GetExternalChannelUri() string

func (*ApiDeployment) GetIntendedAudience 

func (x *ApiDeployment) GetIntendedAudience() string

func (*ApiDeployment) GetLabels 

func (x *ApiDeployment) GetLabels() map[string]string

func (*ApiDeployment) GetName 

func (x *ApiDeployment) GetName() string

func (*ApiDeployment) GetRevisionCreateTime 

func (x *ApiDeployment) GetRevisionCreateTime() *timestamppb.Timestamp

func (*ApiDeployment) GetRevisionId 

func (x *ApiDeployment) GetRevisionId() string

func (*ApiDeployment) GetRevisionUpdateTime 

func (x *ApiDeployment) GetRevisionUpdateTime() *timestamppb.Timestamp

func (*ApiDeployment) ProtoMessage 

func (*ApiDeployment) ProtoMessage()

func (*ApiDeployment) ProtoReflect 

func (x *ApiDeployment) ProtoReflect() protoreflect.Message

func (*ApiDeployment) Reset 

func (x *ApiDeployment) Reset()

func (*ApiDeployment) String 

func (x *ApiDeployment) String() string

type ApiDeploymentEventData 

type ApiDeploymentEventData struct {

	// Optional. The ApiDeployment event payload. Unset for deletion events.
	Payload *ApiDeployment `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all ApiDeployment events.

func (*ApiDeploymentEventData) Descriptor deprecated 

func (*ApiDeploymentEventData) Descriptor() ([]byte, []int)

Deprecated: Use ApiDeploymentEventData.ProtoReflect.Descriptor instead.

func (*ApiDeploymentEventData) GetPayload 

func (x *ApiDeploymentEventData) GetPayload() *ApiDeployment

func (*ApiDeploymentEventData) ProtoMessage 

func (*ApiDeploymentEventData) ProtoMessage()

func (*ApiDeploymentEventData) ProtoReflect 

func (x *ApiDeploymentEventData) ProtoReflect() protoreflect.Message

func (*ApiDeploymentEventData) Reset 

func (x *ApiDeploymentEventData) Reset()

func (*ApiDeploymentEventData) String 

func (x *ApiDeploymentEventData) String() string

type ApiEventData 

type ApiEventData struct {

	// Optional. The Api event payload. Unset for deletion events.
	Payload *Api `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Api events.

func (*ApiEventData) Descriptor deprecated 

func (*ApiEventData) Descriptor() ([]byte, []int)

Deprecated: Use ApiEventData.ProtoReflect.Descriptor instead.

func (*ApiEventData) GetPayload 

func (x *ApiEventData) GetPayload() *Api

func (*ApiEventData) ProtoMessage 

func (*ApiEventData) ProtoMessage()

func (*ApiEventData) ProtoReflect 

func (x *ApiEventData) ProtoReflect() protoreflect.Message

func (*ApiEventData) Reset 

func (x *ApiEventData) Reset()

func (*ApiEventData) String 

func (x *ApiEventData) String() string

type ApiSpec 

type ApiSpec struct {

	// Resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A possibly-hierarchical name used to refer to the spec from other specs.
	Filename string `protobuf:"bytes,2,opt,name=filename,proto3" json:"filename,omitempty"`
	// A detailed description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Immutable. The revision ID of the spec.
	// A new revision is committed whenever the spec contents are changed.
	// The format is an 8-character hexadecimal string.
	RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// Output only. Creation timestamp; when the spec resource was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Revision creation timestamp; when the represented revision was
	// created.
	RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
	// Output only. Last update timestamp: when the represented revision was last
	// modified.
	RevisionUpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=revision_update_time,json=revisionUpdateTime,proto3" json:"revision_update_time,omitempty"`
	// A style (format) descriptor for this spec that is specified as a Media Type
	// (https://en.wikipedia.org/wiki/Media_type). Possible values include
	// `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and
	// `application/vnd.apigee.graphql`, with possible suffixes representing
	// compression types. These hypothetical names are defined in the vendor tree
	// defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
	// Content types can specify compression. Currently only GZip compression is
	// supported (indicated with "+gzip").
	MimeType string `protobuf:"bytes,8,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Output only. The size of the spec file in bytes. If the spec is gzipped,
	// this is the size of the uncompressed spec.
	SizeBytes int32 `protobuf:"varint,9,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped,
	// this is the hash of the uncompressed spec.
	Hash string `protobuf:"bytes,10,opt,name=hash,proto3" json:"hash,omitempty"`
	// The original source URI of the spec (if one exists).
	// This is an external location that can be used for reference purposes
	// but which may not be authoritative since this external resource may
	// change after the spec is retrieved.
	SourceUri string `protobuf:"bytes,11,opt,name=source_uri,json=sourceUri,proto3" json:"source_uri,omitempty"`
	// Labels attach identifying metadata to resources. Identifying metadata can
	// be used to filter list operations.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one resource (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with
	// `apigeeregistry.googleapis.com/` and cannot be changed.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Annotations attach non-identifying metadata to resources.
	//
	// Annotation keys and values are less restricted than those of labels, but
	// should be generally used for small values of broad interest. Larger, topic-
	// specific metadata should be stored in Artifacts.
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.

func (*ApiSpec) Descriptor deprecated 

func (*ApiSpec) Descriptor() ([]byte, []int)

Deprecated: Use ApiSpec.ProtoReflect.Descriptor instead.

func (*ApiSpec) GetAnnotations 

func (x *ApiSpec) GetAnnotations() map[string]string

func (*ApiSpec) GetCreateTime 

func (x *ApiSpec) GetCreateTime() *timestamppb.Timestamp

func (*ApiSpec) GetDescription 

func (x *ApiSpec) GetDescription() string

func (*ApiSpec) GetFilename 

func (x *ApiSpec) GetFilename() string

func (*ApiSpec) GetHash 

func (x *ApiSpec) GetHash() string

func (*ApiSpec) GetLabels 

func (x *ApiSpec) GetLabels() map[string]string

func (*ApiSpec) GetMimeType 

func (x *ApiSpec) GetMimeType() string

func (*ApiSpec) GetName 

func (x *ApiSpec) GetName() string

func (*ApiSpec) GetRevisionCreateTime 

func (x *ApiSpec) GetRevisionCreateTime() *timestamppb.Timestamp

func (*ApiSpec) GetRevisionId 

func (x *ApiSpec) GetRevisionId() string

func (*ApiSpec) GetRevisionUpdateTime 

func (x *ApiSpec) GetRevisionUpdateTime() *timestamppb.Timestamp

func (*ApiSpec) GetSizeBytes 

func (x *ApiSpec) GetSizeBytes() int32

func (*ApiSpec) GetSourceUri 

func (x *ApiSpec) GetSourceUri() string

func (*ApiSpec) ProtoMessage 

func (*ApiSpec) ProtoMessage()

func (*ApiSpec) ProtoReflect 

func (x *ApiSpec) ProtoReflect() protoreflect.Message

func (*ApiSpec) Reset 

func (x *ApiSpec) Reset()

func (*ApiSpec) String 

func (x *ApiSpec) String() string

type ApiSpecEventData 

type ApiSpecEventData struct {

	// Optional. The ApiSpec event payload. Unset for deletion events.
	Payload *ApiSpec `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all ApiSpec events.

func (*ApiSpecEventData) Descriptor deprecated 

func (*ApiSpecEventData) Descriptor() ([]byte, []int)

Deprecated: Use ApiSpecEventData.ProtoReflect.Descriptor instead.

func (*ApiSpecEventData) GetPayload 

func (x *ApiSpecEventData) GetPayload() *ApiSpec

func (*ApiSpecEventData) ProtoMessage 

func (*ApiSpecEventData) ProtoMessage()

func (*ApiSpecEventData) ProtoReflect 

func (x *ApiSpecEventData) ProtoReflect() protoreflect.Message

func (*ApiSpecEventData) Reset 

func (x *ApiSpecEventData) Reset()

func (*ApiSpecEventData) String 

func (x *ApiSpecEventData) String() string

type ApiVersion 

type ApiVersion struct {

	// Resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-meaningful name.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Last update timestamp.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// A user-definable description of the lifecycle phase of this API version.
	// Format: free-form, but we expect single words that describe API maturity,
	// e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION",
	// "DEPRECATED", "RETIRED".
	State string `protobuf:"bytes,6,opt,name=state,proto3" json:"state,omitempty"`
	// Labels attach identifying metadata to resources. Identifying metadata can
	// be used to filter list operations.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one resource (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with
	// `apigeeregistry.googleapis.com/` and cannot be changed.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Annotations attach non-identifying metadata to resources.
	//
	// Annotation keys and values are less restricted than those of labels, but
	// should be generally used for small values of broad interest. Larger, topic-
	// specific metadata should be stored in Artifacts.
	Annotations map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a particular version of an API. ApiVersions are what consumers actually use.

func (*ApiVersion) Descriptor deprecated 

func (*ApiVersion) Descriptor() ([]byte, []int)

Deprecated: Use ApiVersion.ProtoReflect.Descriptor instead.

func (*ApiVersion) GetAnnotations 

func (x *ApiVersion) GetAnnotations() map[string]string

func (*ApiVersion) GetCreateTime 

func (x *ApiVersion) GetCreateTime() *timestamppb.Timestamp

func (*ApiVersion) GetDescription 

func (x *ApiVersion) GetDescription() string

func (*ApiVersion) GetDisplayName 

func (x *ApiVersion) GetDisplayName() string

func (*ApiVersion) GetLabels 

func (x *ApiVersion) GetLabels() map[string]string

func (*ApiVersion) GetName 

func (x *ApiVersion) GetName() string

func (*ApiVersion) GetState 

func (x *ApiVersion) GetState() string

func (*ApiVersion) GetUpdateTime 

func (x *ApiVersion) GetUpdateTime() *timestamppb.Timestamp

func (*ApiVersion) ProtoMessage 

func (*ApiVersion) ProtoMessage()

func (*ApiVersion) ProtoReflect 

func (x *ApiVersion) ProtoReflect() protoreflect.Message

func (*ApiVersion) Reset 

func (x *ApiVersion) Reset()

func (*ApiVersion) String 

func (x *ApiVersion) String() string

type ApiVersionEventData 

type ApiVersionEventData struct {

	// Optional. The ApiVersion event payload. Unset for deletion events.
	Payload *ApiVersion `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all ApiVersion events.

func (*ApiVersionEventData) Descriptor deprecated 

func (*ApiVersionEventData) Descriptor() ([]byte, []int)

Deprecated: Use ApiVersionEventData.ProtoReflect.Descriptor instead.

func (*ApiVersionEventData) GetPayload 

func (x *ApiVersionEventData) GetPayload() *ApiVersion

func (*ApiVersionEventData) ProtoMessage 

func (*ApiVersionEventData) ProtoMessage()

func (*ApiVersionEventData) ProtoReflect 

func (x *ApiVersionEventData) ProtoReflect() protoreflect.Message

func (*ApiVersionEventData) Reset 

func (x *ApiVersionEventData) Reset()

func (*ApiVersionEventData) String 

func (x *ApiVersionEventData) String() string

type Instance 

type Instance struct {

	// Format: `projects/*/locations/*/instance`.
	// Currently only `locations/global` is supported.
	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 Instance.
	State Instance_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.events.cloud.apigeeregistry.v1.Instance_State" json:"state,omitempty"`
	// Output only. Extra information of Instance.State if the state is `FAILED`.
	StateMessage string `protobuf:"bytes,5,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// Required. Config of the Instance.
	Config *Instance_Config `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.

func (*Instance) Descriptor deprecated 

func (*Instance) Descriptor() ([]byte, []int)

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetConfig 

func (x *Instance) GetConfig() *Instance_Config

func (*Instance) GetCreateTime 

func (x *Instance) GetCreateTime() *timestamppb.Timestamp

func (*Instance) GetName 

func (x *Instance) GetName() string

func (*Instance) GetState 

func (x *Instance) GetState() Instance_State

func (*Instance) GetStateMessage 

func (x *Instance) GetStateMessage() string

func (*Instance) GetUpdateTime 

func (x *Instance) GetUpdateTime() *timestamppb.Timestamp

func (*Instance) ProtoMessage 

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect 

func (x *Instance) ProtoReflect() protoreflect.Message

func (*Instance) Reset 

func (x *Instance) Reset()

func (*Instance) String 

func (x *Instance) String() string

type InstanceEventData 

type InstanceEventData struct {

	// Optional. The Instance event payload. Unset for deletion events.
	Payload *Instance `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Instance events.

func (*InstanceEventData) Descriptor deprecated 

func (*InstanceEventData) Descriptor() ([]byte, []int)

Deprecated: Use InstanceEventData.ProtoReflect.Descriptor instead.

func (*InstanceEventData) GetPayload 

func (x *InstanceEventData) GetPayload() *Instance

func (*InstanceEventData) ProtoMessage 

func (*InstanceEventData) ProtoMessage()

func (*InstanceEventData) ProtoReflect 

func (x *InstanceEventData) ProtoReflect() protoreflect.Message

func (*InstanceEventData) Reset 

func (x *InstanceEventData) Reset()

func (*InstanceEventData) String 

func (x *InstanceEventData) String() string

type Instance_Config 

type Instance_Config struct {

	// Output only. The GCP location where the Instance resides.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// 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 InstanceConfig.location.
	CmekKeyName string `protobuf:"bytes,2,opt,name=cmek_key_name,json=cmekKeyName,proto3" json:"cmek_key_name,omitempty"`
	// contains filtered or unexported fields
}

Available configurations to provision an Instance.

func (*Instance_Config) Descriptor deprecated 

func (*Instance_Config) Descriptor() ([]byte, []int)

Deprecated: Use Instance_Config.ProtoReflect.Descriptor instead.

func (*Instance_Config) GetCmekKeyName 

func (x *Instance_Config) GetCmekKeyName() string

func (*Instance_Config) GetLocation 

func (x *Instance_Config) GetLocation() string

func (*Instance_Config) ProtoMessage 

func (*Instance_Config) ProtoMessage()

func (*Instance_Config) ProtoReflect 

func (x *Instance_Config) ProtoReflect() protoreflect.Message

func (*Instance_Config) Reset 

func (x *Instance_Config) Reset()

func (*Instance_Config) String 

func (x *Instance_Config) String() string

type Instance_State 

type Instance_State int32

State of the Instance. 

const (
	// The default value. This value is used if the state is omitted.
	Instance_STATE_UNSPECIFIED Instance_State = 0
	// The Instance has not been initialized or has been deleted.
	Instance_INACTIVE Instance_State = 1
	// The Instance is being created.
	Instance_CREATING Instance_State = 2
	// The Instance has been created and is ready for use.
	Instance_ACTIVE Instance_State = 3
	// The Instance is being updated.
	Instance_UPDATING Instance_State = 4
	// The Instance is being deleted.
	Instance_DELETING Instance_State = 5
	// The Instance encountered an error during a state change.
	Instance_FAILED Instance_State = 6
)

func (Instance_State) Descriptor 

func (Instance_State) Descriptor() protoreflect.EnumDescriptor

func (Instance_State) Enum 

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor deprecated 

func (Instance_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number 

func (x Instance_State) Number() protoreflect.EnumNumber

func (Instance_State) String 

func (x Instance_State) String() string

func (Instance_State) Type 

func (Instance_State) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.