apigeeregistryv1

package
v1.36.11-2024050211440... Latest Latest
Warning

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

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

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_google_events_cloud_apigeeregistry_v1_data_proto protoreflect.FileDescriptor
View Source
var File_google_events_cloud_apigeeregistry_v1_events_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 `` /* 139-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 `` /* 150-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) ClearCreateTime

func (x *Api) ClearCreateTime()

func (*Api) ClearUpdateTime

func (x *Api) ClearUpdateTime()

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) HasCreateTime

func (x *Api) HasCreateTime() bool

func (*Api) HasUpdateTime

func (x *Api) HasUpdateTime() bool

func (*Api) ProtoMessage

func (*Api) ProtoMessage()

func (*Api) ProtoReflect

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

func (*Api) Reset

func (x *Api) Reset()

func (*Api) SetAnnotations

func (x *Api) SetAnnotations(v map[string]string)

func (*Api) SetAvailability

func (x *Api) SetAvailability(v string)

func (*Api) SetCreateTime

func (x *Api) SetCreateTime(v *timestamppb.Timestamp)

func (*Api) SetDescription

func (x *Api) SetDescription(v string)

func (*Api) SetDisplayName

func (x *Api) SetDisplayName(v string)

func (*Api) SetLabels

func (x *Api) SetLabels(v map[string]string)

func (*Api) SetName

func (x *Api) SetName(v string)

func (*Api) SetRecommendedDeployment

func (x *Api) SetRecommendedDeployment(v string)

func (*Api) SetRecommendedVersion

func (x *Api) SetRecommendedVersion(v string)

func (*Api) SetUpdateTime

func (x *Api) SetUpdateTime(v *timestamppb.Timestamp)

func (*Api) String

func (x *Api) String() string

type ApiCreatedEvent

type ApiCreatedEvent struct {

	// The data associated with the event.
	Data *ApiEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Api is created.

func (*ApiCreatedEvent) ClearData

func (x *ApiCreatedEvent) ClearData()

func (*ApiCreatedEvent) GetData

func (x *ApiCreatedEvent) GetData() *ApiEventData

func (*ApiCreatedEvent) HasData

func (x *ApiCreatedEvent) HasData() bool

func (*ApiCreatedEvent) ProtoMessage

func (*ApiCreatedEvent) ProtoMessage()

func (*ApiCreatedEvent) ProtoReflect

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

func (*ApiCreatedEvent) Reset

func (x *ApiCreatedEvent) Reset()

func (*ApiCreatedEvent) SetData

func (x *ApiCreatedEvent) SetData(v *ApiEventData)

func (*ApiCreatedEvent) String

func (x *ApiCreatedEvent) String() string

type ApiCreatedEvent_builder

type ApiCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiEventData
	// contains filtered or unexported fields
}

func (ApiCreatedEvent_builder) Build

type ApiDeletedEvent

type ApiDeletedEvent struct {

	// The data associated with the event.
	Data *ApiEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Api is deleted.

func (*ApiDeletedEvent) ClearData

func (x *ApiDeletedEvent) ClearData()

func (*ApiDeletedEvent) GetData

func (x *ApiDeletedEvent) GetData() *ApiEventData

func (*ApiDeletedEvent) HasData

func (x *ApiDeletedEvent) HasData() bool

func (*ApiDeletedEvent) ProtoMessage

func (*ApiDeletedEvent) ProtoMessage()

func (*ApiDeletedEvent) ProtoReflect

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

func (*ApiDeletedEvent) Reset

func (x *ApiDeletedEvent) Reset()

func (*ApiDeletedEvent) SetData

func (x *ApiDeletedEvent) SetData(v *ApiEventData)

func (*ApiDeletedEvent) String

func (x *ApiDeletedEvent) String() string

type ApiDeletedEvent_builder

type ApiDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ApiEventData
	// contains filtered or unexported fields
}

func (ApiDeletedEvent_builder) Build

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 `` /* 140-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 `` /* 150-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) ClearCreateTime

func (x *ApiDeployment) ClearCreateTime()

func (*ApiDeployment) ClearRevisionCreateTime

func (x *ApiDeployment) ClearRevisionCreateTime()

func (*ApiDeployment) ClearRevisionUpdateTime

func (x *ApiDeployment) ClearRevisionUpdateTime()

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) HasCreateTime

func (x *ApiDeployment) HasCreateTime() bool

func (*ApiDeployment) HasRevisionCreateTime

func (x *ApiDeployment) HasRevisionCreateTime() bool

func (*ApiDeployment) HasRevisionUpdateTime

func (x *ApiDeployment) HasRevisionUpdateTime() bool

func (*ApiDeployment) ProtoMessage

func (*ApiDeployment) ProtoMessage()

func (*ApiDeployment) ProtoReflect

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

func (*ApiDeployment) Reset

func (x *ApiDeployment) Reset()

func (*ApiDeployment) SetAccessGuidance

func (x *ApiDeployment) SetAccessGuidance(v string)

func (*ApiDeployment) SetAnnotations

func (x *ApiDeployment) SetAnnotations(v map[string]string)

func (*ApiDeployment) SetApiSpecRevision

func (x *ApiDeployment) SetApiSpecRevision(v string)

func (*ApiDeployment) SetCreateTime

func (x *ApiDeployment) SetCreateTime(v *timestamppb.Timestamp)

func (*ApiDeployment) SetDescription

func (x *ApiDeployment) SetDescription(v string)

func (*ApiDeployment) SetDisplayName

func (x *ApiDeployment) SetDisplayName(v string)

func (*ApiDeployment) SetEndpointUri

func (x *ApiDeployment) SetEndpointUri(v string)

func (*ApiDeployment) SetExternalChannelUri

func (x *ApiDeployment) SetExternalChannelUri(v string)

func (*ApiDeployment) SetIntendedAudience

func (x *ApiDeployment) SetIntendedAudience(v string)

func (*ApiDeployment) SetLabels

func (x *ApiDeployment) SetLabels(v map[string]string)

func (*ApiDeployment) SetName

func (x *ApiDeployment) SetName(v string)

func (*ApiDeployment) SetRevisionCreateTime

func (x *ApiDeployment) SetRevisionCreateTime(v *timestamppb.Timestamp)

func (*ApiDeployment) SetRevisionId

func (x *ApiDeployment) SetRevisionId(v string)

func (*ApiDeployment) SetRevisionUpdateTime

func (x *ApiDeployment) SetRevisionUpdateTime(v *timestamppb.Timestamp)

func (*ApiDeployment) String

func (x *ApiDeployment) String() string

type ApiDeploymentCreatedEvent

type ApiDeploymentCreatedEvent struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiDeployment is created.

func (*ApiDeploymentCreatedEvent) ClearData

func (x *ApiDeploymentCreatedEvent) ClearData()

func (*ApiDeploymentCreatedEvent) GetData

func (*ApiDeploymentCreatedEvent) HasData

func (x *ApiDeploymentCreatedEvent) HasData() bool

func (*ApiDeploymentCreatedEvent) ProtoMessage

func (*ApiDeploymentCreatedEvent) ProtoMessage()

func (*ApiDeploymentCreatedEvent) ProtoReflect

func (*ApiDeploymentCreatedEvent) Reset

func (x *ApiDeploymentCreatedEvent) Reset()

func (*ApiDeploymentCreatedEvent) SetData

func (*ApiDeploymentCreatedEvent) String

func (x *ApiDeploymentCreatedEvent) String() string

type ApiDeploymentCreatedEvent_builder

type ApiDeploymentCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData
	// contains filtered or unexported fields
}

func (ApiDeploymentCreatedEvent_builder) Build

type ApiDeploymentDeletedEvent

type ApiDeploymentDeletedEvent struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiDeployment is deleted.

func (*ApiDeploymentDeletedEvent) ClearData

func (x *ApiDeploymentDeletedEvent) ClearData()

func (*ApiDeploymentDeletedEvent) GetData

func (*ApiDeploymentDeletedEvent) HasData

func (x *ApiDeploymentDeletedEvent) HasData() bool

func (*ApiDeploymentDeletedEvent) ProtoMessage

func (*ApiDeploymentDeletedEvent) ProtoMessage()

func (*ApiDeploymentDeletedEvent) ProtoReflect

func (*ApiDeploymentDeletedEvent) Reset

func (x *ApiDeploymentDeletedEvent) Reset()

func (*ApiDeploymentDeletedEvent) SetData

func (*ApiDeploymentDeletedEvent) String

func (x *ApiDeploymentDeletedEvent) String() string

type ApiDeploymentDeletedEvent_builder

type ApiDeploymentDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData
	// contains filtered or unexported fields
}

func (ApiDeploymentDeletedEvent_builder) Build

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) ClearPayload

func (x *ApiDeploymentEventData) ClearPayload()

func (*ApiDeploymentEventData) GetPayload

func (x *ApiDeploymentEventData) GetPayload() *ApiDeployment

func (*ApiDeploymentEventData) HasPayload

func (x *ApiDeploymentEventData) HasPayload() bool

func (*ApiDeploymentEventData) ProtoMessage

func (*ApiDeploymentEventData) ProtoMessage()

func (*ApiDeploymentEventData) ProtoReflect

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

func (*ApiDeploymentEventData) Reset

func (x *ApiDeploymentEventData) Reset()

func (*ApiDeploymentEventData) SetPayload

func (x *ApiDeploymentEventData) SetPayload(v *ApiDeployment)

func (*ApiDeploymentEventData) String

func (x *ApiDeploymentEventData) String() string

type ApiDeploymentEventData_builder

type ApiDeploymentEventData_builder struct {

	// Optional. The ApiDeployment event payload. Unset for deletion events.
	Payload *ApiDeployment
	// contains filtered or unexported fields
}

func (ApiDeploymentEventData_builder) Build

type ApiDeploymentUpdatedEvent

type ApiDeploymentUpdatedEvent struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiDeployment is updated.

func (*ApiDeploymentUpdatedEvent) ClearData

func (x *ApiDeploymentUpdatedEvent) ClearData()

func (*ApiDeploymentUpdatedEvent) GetData

func (*ApiDeploymentUpdatedEvent) HasData

func (x *ApiDeploymentUpdatedEvent) HasData() bool

func (*ApiDeploymentUpdatedEvent) ProtoMessage

func (*ApiDeploymentUpdatedEvent) ProtoMessage()

func (*ApiDeploymentUpdatedEvent) ProtoReflect

func (*ApiDeploymentUpdatedEvent) Reset

func (x *ApiDeploymentUpdatedEvent) Reset()

func (*ApiDeploymentUpdatedEvent) SetData

func (*ApiDeploymentUpdatedEvent) String

func (x *ApiDeploymentUpdatedEvent) String() string

type ApiDeploymentUpdatedEvent_builder

type ApiDeploymentUpdatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiDeploymentEventData
	// contains filtered or unexported fields
}

func (ApiDeploymentUpdatedEvent_builder) Build

type ApiDeployment_builder

type ApiDeployment_builder struct {

	// Resource name.
	Name string
	// Human-meaningful name.
	DisplayName string
	// A detailed description.
	Description string
	// 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
	// Output only. Creation timestamp; when the deployment resource was created.
	CreateTime *timestamppb.Timestamp
	// Output only. Revision creation timestamp; when the represented revision was
	// created.
	RevisionCreateTime *timestamppb.Timestamp
	// Output only. Last update timestamp: when the represented revision was last
	// modified.
	RevisionUpdateTime *timestamppb.Timestamp
	// 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
	// The address where the deployment is serving. Changes to this value will
	// update the revision.
	EndpointUri string
	// 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
	// Text briefly identifying the intended audience of the API. Changes to this
	// value will not affect the revision.
	IntendedAudience string
	// Text briefly describing how to access the endpoint. Changes to this value
	// will not affect the revision.
	AccessGuidance string
	// 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
	// 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
	// contains filtered or unexported fields
}

func (ApiDeployment_builder) Build

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) ClearPayload

func (x *ApiEventData) ClearPayload()

func (*ApiEventData) GetPayload

func (x *ApiEventData) GetPayload() *Api

func (*ApiEventData) HasPayload

func (x *ApiEventData) HasPayload() bool

func (*ApiEventData) ProtoMessage

func (*ApiEventData) ProtoMessage()

func (*ApiEventData) ProtoReflect

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

func (*ApiEventData) Reset

func (x *ApiEventData) Reset()

func (*ApiEventData) SetPayload

func (x *ApiEventData) SetPayload(v *Api)

func (*ApiEventData) String

func (x *ApiEventData) String() string

type ApiEventData_builder

type ApiEventData_builder struct {

	// Optional. The Api event payload. Unset for deletion events.
	Payload *Api
	// contains filtered or unexported fields
}

func (ApiEventData_builder) Build

func (b0 ApiEventData_builder) Build() *ApiEventData

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 `` /* 140-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 `` /* 150-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) ClearCreateTime

func (x *ApiSpec) ClearCreateTime()

func (*ApiSpec) ClearRevisionCreateTime

func (x *ApiSpec) ClearRevisionCreateTime()

func (*ApiSpec) ClearRevisionUpdateTime

func (x *ApiSpec) ClearRevisionUpdateTime()

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) HasCreateTime

func (x *ApiSpec) HasCreateTime() bool

func (*ApiSpec) HasRevisionCreateTime

func (x *ApiSpec) HasRevisionCreateTime() bool

func (*ApiSpec) HasRevisionUpdateTime

func (x *ApiSpec) HasRevisionUpdateTime() bool

func (*ApiSpec) ProtoMessage

func (*ApiSpec) ProtoMessage()

func (*ApiSpec) ProtoReflect

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

func (*ApiSpec) Reset

func (x *ApiSpec) Reset()

func (*ApiSpec) SetAnnotations

func (x *ApiSpec) SetAnnotations(v map[string]string)

func (*ApiSpec) SetCreateTime

func (x *ApiSpec) SetCreateTime(v *timestamppb.Timestamp)

func (*ApiSpec) SetDescription

func (x *ApiSpec) SetDescription(v string)

func (*ApiSpec) SetFilename

func (x *ApiSpec) SetFilename(v string)

func (*ApiSpec) SetHash

func (x *ApiSpec) SetHash(v string)

func (*ApiSpec) SetLabels

func (x *ApiSpec) SetLabels(v map[string]string)

func (*ApiSpec) SetMimeType

func (x *ApiSpec) SetMimeType(v string)

func (*ApiSpec) SetName

func (x *ApiSpec) SetName(v string)

func (*ApiSpec) SetRevisionCreateTime

func (x *ApiSpec) SetRevisionCreateTime(v *timestamppb.Timestamp)

func (*ApiSpec) SetRevisionId

func (x *ApiSpec) SetRevisionId(v string)

func (*ApiSpec) SetRevisionUpdateTime

func (x *ApiSpec) SetRevisionUpdateTime(v *timestamppb.Timestamp)

func (*ApiSpec) SetSizeBytes

func (x *ApiSpec) SetSizeBytes(v int32)

func (*ApiSpec) SetSourceUri

func (x *ApiSpec) SetSourceUri(v string)

func (*ApiSpec) String

func (x *ApiSpec) String() string

type ApiSpecCreatedEvent

type ApiSpecCreatedEvent struct {

	// The data associated with the event.
	Data *ApiSpecEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiSpec is created.

func (*ApiSpecCreatedEvent) ClearData

func (x *ApiSpecCreatedEvent) ClearData()

func (*ApiSpecCreatedEvent) GetData

func (x *ApiSpecCreatedEvent) GetData() *ApiSpecEventData

func (*ApiSpecCreatedEvent) HasData

func (x *ApiSpecCreatedEvent) HasData() bool

func (*ApiSpecCreatedEvent) ProtoMessage

func (*ApiSpecCreatedEvent) ProtoMessage()

func (*ApiSpecCreatedEvent) ProtoReflect

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

func (*ApiSpecCreatedEvent) Reset

func (x *ApiSpecCreatedEvent) Reset()

func (*ApiSpecCreatedEvent) SetData

func (x *ApiSpecCreatedEvent) SetData(v *ApiSpecEventData)

func (*ApiSpecCreatedEvent) String

func (x *ApiSpecCreatedEvent) String() string

type ApiSpecCreatedEvent_builder

type ApiSpecCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiSpecEventData
	// contains filtered or unexported fields
}

func (ApiSpecCreatedEvent_builder) Build

type ApiSpecDeletedEvent

type ApiSpecDeletedEvent struct {

	// The data associated with the event.
	Data *ApiSpecEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiSpec is deleted.

func (*ApiSpecDeletedEvent) ClearData

func (x *ApiSpecDeletedEvent) ClearData()

func (*ApiSpecDeletedEvent) GetData

func (x *ApiSpecDeletedEvent) GetData() *ApiSpecEventData

func (*ApiSpecDeletedEvent) HasData

func (x *ApiSpecDeletedEvent) HasData() bool

func (*ApiSpecDeletedEvent) ProtoMessage

func (*ApiSpecDeletedEvent) ProtoMessage()

func (*ApiSpecDeletedEvent) ProtoReflect

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

func (*ApiSpecDeletedEvent) Reset

func (x *ApiSpecDeletedEvent) Reset()

func (*ApiSpecDeletedEvent) SetData

func (x *ApiSpecDeletedEvent) SetData(v *ApiSpecEventData)

func (*ApiSpecDeletedEvent) String

func (x *ApiSpecDeletedEvent) String() string

type ApiSpecDeletedEvent_builder

type ApiSpecDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ApiSpecEventData
	// contains filtered or unexported fields
}

func (ApiSpecDeletedEvent_builder) Build

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) ClearPayload

func (x *ApiSpecEventData) ClearPayload()

func (*ApiSpecEventData) GetPayload

func (x *ApiSpecEventData) GetPayload() *ApiSpec

func (*ApiSpecEventData) HasPayload

func (x *ApiSpecEventData) HasPayload() bool

func (*ApiSpecEventData) ProtoMessage

func (*ApiSpecEventData) ProtoMessage()

func (*ApiSpecEventData) ProtoReflect

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

func (*ApiSpecEventData) Reset

func (x *ApiSpecEventData) Reset()

func (*ApiSpecEventData) SetPayload

func (x *ApiSpecEventData) SetPayload(v *ApiSpec)

func (*ApiSpecEventData) String

func (x *ApiSpecEventData) String() string

type ApiSpecEventData_builder

type ApiSpecEventData_builder struct {

	// Optional. The ApiSpec event payload. Unset for deletion events.
	Payload *ApiSpec
	// contains filtered or unexported fields
}

func (ApiSpecEventData_builder) Build

type ApiSpecUpdatedEvent

type ApiSpecUpdatedEvent struct {

	// The data associated with the event.
	Data *ApiSpecEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiSpec is updated.

func (*ApiSpecUpdatedEvent) ClearData

func (x *ApiSpecUpdatedEvent) ClearData()

func (*ApiSpecUpdatedEvent) GetData

func (x *ApiSpecUpdatedEvent) GetData() *ApiSpecEventData

func (*ApiSpecUpdatedEvent) HasData

func (x *ApiSpecUpdatedEvent) HasData() bool

func (*ApiSpecUpdatedEvent) ProtoMessage

func (*ApiSpecUpdatedEvent) ProtoMessage()

func (*ApiSpecUpdatedEvent) ProtoReflect

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

func (*ApiSpecUpdatedEvent) Reset

func (x *ApiSpecUpdatedEvent) Reset()

func (*ApiSpecUpdatedEvent) SetData

func (x *ApiSpecUpdatedEvent) SetData(v *ApiSpecEventData)

func (*ApiSpecUpdatedEvent) String

func (x *ApiSpecUpdatedEvent) String() string

type ApiSpecUpdatedEvent_builder

type ApiSpecUpdatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiSpecEventData
	// contains filtered or unexported fields
}

func (ApiSpecUpdatedEvent_builder) Build

type ApiSpec_builder

type ApiSpec_builder struct {

	// Resource name.
	Name string
	// A possibly-hierarchical name used to refer to the spec from other specs.
	Filename string
	// A detailed description.
	Description string
	// 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
	// Output only. Creation timestamp; when the spec resource was created.
	CreateTime *timestamppb.Timestamp
	// Output only. Revision creation timestamp; when the represented revision was
	// created.
	RevisionCreateTime *timestamppb.Timestamp
	// Output only. Last update timestamp: when the represented revision was last
	// modified.
	RevisionUpdateTime *timestamppb.Timestamp
	// 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
	// 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
	// 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
	// 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
	// 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
	// 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
	// contains filtered or unexported fields
}

func (ApiSpec_builder) Build

func (b0 ApiSpec_builder) Build() *ApiSpec

type ApiUpdatedEvent

type ApiUpdatedEvent struct {

	// The data associated with the event.
	Data *ApiEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Api is updated.

func (*ApiUpdatedEvent) ClearData

func (x *ApiUpdatedEvent) ClearData()

func (*ApiUpdatedEvent) GetData

func (x *ApiUpdatedEvent) GetData() *ApiEventData

func (*ApiUpdatedEvent) HasData

func (x *ApiUpdatedEvent) HasData() bool

func (*ApiUpdatedEvent) ProtoMessage

func (*ApiUpdatedEvent) ProtoMessage()

func (*ApiUpdatedEvent) ProtoReflect

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

func (*ApiUpdatedEvent) Reset

func (x *ApiUpdatedEvent) Reset()

func (*ApiUpdatedEvent) SetData

func (x *ApiUpdatedEvent) SetData(v *ApiEventData)

func (*ApiUpdatedEvent) String

func (x *ApiUpdatedEvent) String() string

type ApiUpdatedEvent_builder

type ApiUpdatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiEventData
	// contains filtered or unexported fields
}

func (ApiUpdatedEvent_builder) Build

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 `` /* 139-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 `` /* 149-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) ClearCreateTime

func (x *ApiVersion) ClearCreateTime()

func (*ApiVersion) ClearUpdateTime

func (x *ApiVersion) ClearUpdateTime()

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) HasCreateTime

func (x *ApiVersion) HasCreateTime() bool

func (*ApiVersion) HasUpdateTime

func (x *ApiVersion) HasUpdateTime() bool

func (*ApiVersion) ProtoMessage

func (*ApiVersion) ProtoMessage()

func (*ApiVersion) ProtoReflect

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

func (*ApiVersion) Reset

func (x *ApiVersion) Reset()

func (*ApiVersion) SetAnnotations

func (x *ApiVersion) SetAnnotations(v map[string]string)

func (*ApiVersion) SetCreateTime

func (x *ApiVersion) SetCreateTime(v *timestamppb.Timestamp)

func (*ApiVersion) SetDescription

func (x *ApiVersion) SetDescription(v string)

func (*ApiVersion) SetDisplayName

func (x *ApiVersion) SetDisplayName(v string)

func (*ApiVersion) SetLabels

func (x *ApiVersion) SetLabels(v map[string]string)

func (*ApiVersion) SetName

func (x *ApiVersion) SetName(v string)

func (*ApiVersion) SetState

func (x *ApiVersion) SetState(v string)

func (*ApiVersion) SetUpdateTime

func (x *ApiVersion) SetUpdateTime(v *timestamppb.Timestamp)

func (*ApiVersion) String

func (x *ApiVersion) String() string

type ApiVersionCreatedEvent

type ApiVersionCreatedEvent struct {

	// The data associated with the event.
	Data *ApiVersionEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiVersion is created.

func (*ApiVersionCreatedEvent) ClearData

func (x *ApiVersionCreatedEvent) ClearData()

func (*ApiVersionCreatedEvent) GetData

func (*ApiVersionCreatedEvent) HasData

func (x *ApiVersionCreatedEvent) HasData() bool

func (*ApiVersionCreatedEvent) ProtoMessage

func (*ApiVersionCreatedEvent) ProtoMessage()

func (*ApiVersionCreatedEvent) ProtoReflect

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

func (*ApiVersionCreatedEvent) Reset

func (x *ApiVersionCreatedEvent) Reset()

func (*ApiVersionCreatedEvent) SetData

func (*ApiVersionCreatedEvent) String

func (x *ApiVersionCreatedEvent) String() string

type ApiVersionCreatedEvent_builder

type ApiVersionCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiVersionEventData
	// contains filtered or unexported fields
}

func (ApiVersionCreatedEvent_builder) Build

type ApiVersionDeletedEvent

type ApiVersionDeletedEvent struct {

	// The data associated with the event.
	Data *ApiVersionEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiVersion is deleted.

func (*ApiVersionDeletedEvent) ClearData

func (x *ApiVersionDeletedEvent) ClearData()

func (*ApiVersionDeletedEvent) GetData

func (*ApiVersionDeletedEvent) HasData

func (x *ApiVersionDeletedEvent) HasData() bool

func (*ApiVersionDeletedEvent) ProtoMessage

func (*ApiVersionDeletedEvent) ProtoMessage()

func (*ApiVersionDeletedEvent) ProtoReflect

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

func (*ApiVersionDeletedEvent) Reset

func (x *ApiVersionDeletedEvent) Reset()

func (*ApiVersionDeletedEvent) SetData

func (*ApiVersionDeletedEvent) String

func (x *ApiVersionDeletedEvent) String() string

type ApiVersionDeletedEvent_builder

type ApiVersionDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ApiVersionEventData
	// contains filtered or unexported fields
}

func (ApiVersionDeletedEvent_builder) Build

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) ClearPayload

func (x *ApiVersionEventData) ClearPayload()

func (*ApiVersionEventData) GetPayload

func (x *ApiVersionEventData) GetPayload() *ApiVersion

func (*ApiVersionEventData) HasPayload

func (x *ApiVersionEventData) HasPayload() bool

func (*ApiVersionEventData) ProtoMessage

func (*ApiVersionEventData) ProtoMessage()

func (*ApiVersionEventData) ProtoReflect

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

func (*ApiVersionEventData) Reset

func (x *ApiVersionEventData) Reset()

func (*ApiVersionEventData) SetPayload

func (x *ApiVersionEventData) SetPayload(v *ApiVersion)

func (*ApiVersionEventData) String

func (x *ApiVersionEventData) String() string

type ApiVersionEventData_builder

type ApiVersionEventData_builder struct {

	// Optional. The ApiVersion event payload. Unset for deletion events.
	Payload *ApiVersion
	// contains filtered or unexported fields
}

func (ApiVersionEventData_builder) Build

type ApiVersionUpdatedEvent

type ApiVersionUpdatedEvent struct {

	// The data associated with the event.
	Data *ApiVersionEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an ApiVersion is updated.

func (*ApiVersionUpdatedEvent) ClearData

func (x *ApiVersionUpdatedEvent) ClearData()

func (*ApiVersionUpdatedEvent) GetData

func (*ApiVersionUpdatedEvent) HasData

func (x *ApiVersionUpdatedEvent) HasData() bool

func (*ApiVersionUpdatedEvent) ProtoMessage

func (*ApiVersionUpdatedEvent) ProtoMessage()

func (*ApiVersionUpdatedEvent) ProtoReflect

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

func (*ApiVersionUpdatedEvent) Reset

func (x *ApiVersionUpdatedEvent) Reset()

func (*ApiVersionUpdatedEvent) SetData

func (*ApiVersionUpdatedEvent) String

func (x *ApiVersionUpdatedEvent) String() string

type ApiVersionUpdatedEvent_builder

type ApiVersionUpdatedEvent_builder struct {

	// The data associated with the event.
	Data *ApiVersionEventData
	// contains filtered or unexported fields
}

func (ApiVersionUpdatedEvent_builder) Build

type ApiVersion_builder

type ApiVersion_builder struct {

	// Resource name.
	Name string
	// Human-meaningful name.
	DisplayName string
	// A detailed description.
	Description string
	// Output only. Creation timestamp.
	CreateTime *timestamppb.Timestamp
	// Output only. Last update timestamp.
	UpdateTime *timestamppb.Timestamp
	// 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
	// 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
	// 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
	// contains filtered or unexported fields
}

func (ApiVersion_builder) Build

func (b0 ApiVersion_builder) Build() *ApiVersion

type Api_builder

type Api_builder struct {

	// Resource name.
	Name string
	// Human-meaningful name.
	DisplayName string
	// A detailed description.
	Description string
	// Output only. Creation timestamp.
	CreateTime *timestamppb.Timestamp
	// Output only. Last update timestamp.
	UpdateTime *timestamppb.Timestamp
	// 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
	// The recommended version of the API.
	// Format:
	// `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
	RecommendedVersion string
	// The recommended deployment of the API.
	// Format:
	// `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`
	RecommendedDeployment string
	// 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
	// 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
	// contains filtered or unexported fields
}

func (Api_builder) Build

func (b0 Api_builder) Build() *Api

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) ClearConfig

func (x *Instance) ClearConfig()

func (*Instance) ClearCreateTime

func (x *Instance) ClearCreateTime()

func (*Instance) ClearUpdateTime

func (x *Instance) ClearUpdateTime()

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) HasConfig

func (x *Instance) HasConfig() bool

func (*Instance) HasCreateTime

func (x *Instance) HasCreateTime() bool

func (*Instance) HasUpdateTime

func (x *Instance) HasUpdateTime() bool

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) SetConfig

func (x *Instance) SetConfig(v *Instance_Config)

func (*Instance) SetCreateTime

func (x *Instance) SetCreateTime(v *timestamppb.Timestamp)

func (*Instance) SetName

func (x *Instance) SetName(v string)

func (*Instance) SetState

func (x *Instance) SetState(v Instance_State)

func (*Instance) SetStateMessage

func (x *Instance) SetStateMessage(v string)

func (*Instance) SetUpdateTime

func (x *Instance) SetUpdateTime(v *timestamppb.Timestamp)

func (*Instance) String

func (x *Instance) String() string

type InstanceCreatedEvent

type InstanceCreatedEvent struct {

	// The data associated with the event.
	Data *InstanceEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Instance is created.

func (*InstanceCreatedEvent) ClearData

func (x *InstanceCreatedEvent) ClearData()

func (*InstanceCreatedEvent) GetData

func (*InstanceCreatedEvent) HasData

func (x *InstanceCreatedEvent) HasData() bool

func (*InstanceCreatedEvent) ProtoMessage

func (*InstanceCreatedEvent) ProtoMessage()

func (*InstanceCreatedEvent) ProtoReflect

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

func (*InstanceCreatedEvent) Reset

func (x *InstanceCreatedEvent) Reset()

func (*InstanceCreatedEvent) SetData

func (x *InstanceCreatedEvent) SetData(v *InstanceEventData)

func (*InstanceCreatedEvent) String

func (x *InstanceCreatedEvent) String() string

type InstanceCreatedEvent_builder

type InstanceCreatedEvent_builder struct {

	// The data associated with the event.
	Data *InstanceEventData
	// contains filtered or unexported fields
}

func (InstanceCreatedEvent_builder) Build

type InstanceDeletedEvent

type InstanceDeletedEvent struct {

	// The data associated with the event.
	Data *InstanceEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Instance is deleted.

func (*InstanceDeletedEvent) ClearData

func (x *InstanceDeletedEvent) ClearData()

func (*InstanceDeletedEvent) GetData

func (*InstanceDeletedEvent) HasData

func (x *InstanceDeletedEvent) HasData() bool

func (*InstanceDeletedEvent) ProtoMessage

func (*InstanceDeletedEvent) ProtoMessage()

func (*InstanceDeletedEvent) ProtoReflect

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

func (*InstanceDeletedEvent) Reset

func (x *InstanceDeletedEvent) Reset()

func (*InstanceDeletedEvent) SetData

func (x *InstanceDeletedEvent) SetData(v *InstanceEventData)

func (*InstanceDeletedEvent) String

func (x *InstanceDeletedEvent) String() string

type InstanceDeletedEvent_builder

type InstanceDeletedEvent_builder struct {

	// The data associated with the event.
	Data *InstanceEventData
	// contains filtered or unexported fields
}

func (InstanceDeletedEvent_builder) Build

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) ClearPayload

func (x *InstanceEventData) ClearPayload()

func (*InstanceEventData) GetPayload

func (x *InstanceEventData) GetPayload() *Instance

func (*InstanceEventData) HasPayload

func (x *InstanceEventData) HasPayload() bool

func (*InstanceEventData) ProtoMessage

func (*InstanceEventData) ProtoMessage()

func (*InstanceEventData) ProtoReflect

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

func (*InstanceEventData) Reset

func (x *InstanceEventData) Reset()

func (*InstanceEventData) SetPayload

func (x *InstanceEventData) SetPayload(v *Instance)

func (*InstanceEventData) String

func (x *InstanceEventData) String() string

type InstanceEventData_builder

type InstanceEventData_builder struct {

	// Optional. The Instance event payload. Unset for deletion events.
	Payload *Instance
	// contains filtered or unexported fields
}

func (InstanceEventData_builder) Build

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) 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) SetCmekKeyName

func (x *Instance_Config) SetCmekKeyName(v string)

func (*Instance_Config) SetLocation

func (x *Instance_Config) SetLocation(v string)

func (*Instance_Config) String

func (x *Instance_Config) String() string

type Instance_Config_builder

type Instance_Config_builder struct {

	// Output only. The GCP location where the Instance resides.
	Location string
	// 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
	// contains filtered or unexported fields
}

func (Instance_Config_builder) Build

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) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type Instance_builder

type Instance_builder struct {

	// Format: `projects/*/locations/*/instance`.
	// Currently only `locations/global` is supported.
	Name string
	// Output only. Creation timestamp.
	CreateTime *timestamppb.Timestamp
	// Output only. Last update timestamp.
	UpdateTime *timestamppb.Timestamp
	// Output only. The current state of the Instance.
	State Instance_State
	// Output only. Extra information of Instance.State if the state is `FAILED`.
	StateMessage string
	// Required. Config of the Instance.
	Config *Instance_Config
	// contains filtered or unexported fields
}

func (Instance_builder) Build

func (b0 Instance_builder) Build() *Instance

Source Files

  • data.pb.go
  • events.pb.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL