package google.cloud.apigeeregistry.v1
Get desktop application:
View/edit binary Protocol Buffers messages
The service that is used for managing the data plane provisioning of the Registry.
Provisions instance resources for the Registry.
message
provisioning_service.proto:75Request message for CreateInstance.
string parent = 1
Required. Parent resource of the Instance, of the form: `projects/*/locations/*`
string instance_id = 2
Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
optional instance = 3
Required. The Instance.
Deletes the Registry instance.
message
provisioning_service.proto:93Request message for DeleteInstance.
string name = 1
Required. The name of the Instance to delete. Format: `projects/*/locations/*/instances/*`.
Gets details of a single Instance.
message
provisioning_service.proto:105Request message for GetInstance.
string name = 1
Required. The name of the Instance to retrieve. Format: `projects/*/locations/*/instances/*`.
The Registry service allows teams to manage descriptions of APIs.
rpc ListApis (, )
registry_service.proto:42Returns matching APIs.
message
registry_service.proto:426Request message for ListApis.
string parent = 1
Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
int32 page_size = 2
The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
string page_token = 3
A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token.
string filter = 4
An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
message
registry_service.proto:455Response message for ListApis.
repeated apis = 1
The APIs from the specified publisher.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
rpc GetApi (, )
registry_service.proto:50Returns a specified API.
message
registry_service.proto:465Request message for GetApi.
string name = 1
Required. The name of the API to retrieve. Format: `projects/*/locations/*/apis/*`
rpc CreateApi (, )
registry_service.proto:58Creates a specified API.
message
registry_service.proto:477Request message for CreateApi.
string parent = 1
Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`
optional api = 2
Required. The API to create.
string api_id = 3
Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.
rpc UpdateApi (, )
registry_service.proto:67Used to modify a specified API.
message
registry_service.proto:501Request message for UpdateApi.
optional api = 1
Required. The API to update. The `name` field is used to identify the API to update. Format: `projects/*/locations/*/apis/*`
optional update_mask = 2
The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
bool allow_missing = 3
If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored.
rpc DeleteApi (, )
registry_service.proto:77Removes a specified API and all of the resources that it owns.
message
registry_service.proto:520Request message for DeleteApi.
string name = 1
Required. The name of the API to delete. Format: `projects/*/locations/*/apis/*`
bool force = 2
If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Returns matching versions.
message
registry_service.proto:536Request message for ListApiVersions.
string parent = 1
Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
int32 page_size = 2
The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
string page_token = 3
A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.
string filter = 4
An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
message
registry_service.proto:565Response message for ListApiVersions.
repeated api_versions = 1
The versions from the specified publisher.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Returns a specified version.
message
registry_service.proto:575Request message for GetApiVersion.
string name = 1
Required. The name of the version to retrieve. Format: `projects/*/locations/*/apis/*/versions/*`
Creates a specified version.
message
registry_service.proto:587Request message for CreateApiVersion.
string parent = 1
Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`
optional api_version = 2
Required. The version to create.
string api_version_id = 3
Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.
Used to modify a specified version.
message
registry_service.proto:611Request message for UpdateApiVersion.
optional api_version = 1
Required. The version to update. The `name` field is used to identify the version to update. Format: `projects/*/locations/*/apis/*/versions/*`
optional update_mask = 2
The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
bool allow_missing = 3
If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.
Removes a specified version and all of the resources that it owns.
message
registry_service.proto:630Request message for DeleteApiVersion.
string name = 1
Required. The name of the version to delete. Format: `projects/*/locations/*/apis/*/versions/*`
bool force = 2
If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Returns matching specs.
message
registry_service.proto:646Request message for ListApiSpecs.
string parent = 1
Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
int32 page_size = 2
The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
string page_token = 3
A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token.
string filter = 4
An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
message
registry_service.proto:675Response message for ListApiSpecs.
repeated api_specs = 1
The specs from the specified publisher.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
rpc GetApiSpec (, )
registry_service.proto:136Returns a specified spec.
message
registry_service.proto:685Request message for GetApiSpec.
string name = 1
Required. The name of the spec to retrieve. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).
message
registry_service.proto:697Request message for GetApiSpecContents.
string name = 1
Required. The name of the spec whose contents should be retrieved. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
Creates a specified spec.
message
registry_service.proto:709Request message for CreateApiSpec.
string parent = 1
Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`
optional api_spec = 2
Required. The spec to create.
string api_spec_id = 3
Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.
Used to modify a specified spec.
message
registry_service.proto:733Request message for UpdateApiSpec.
optional api_spec = 1
Required. The spec to update. The `name` field is used to identify the spec to update. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
optional update_mask = 2
The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
bool allow_missing = 3
If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.
Removes a specified spec, all revisions, and all child resources (e.g., artifacts).
message
registry_service.proto:752Request message for DeleteApiSpec.
string name = 1
Required. The name of the spec to delete. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
bool force = 2
If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Adds a tag to a specified revision of a spec.
message
registry_service.proto:768Request message for TagApiSpecRevision.
string name = 1
Required. The name of the spec to be tagged, including the revision ID.
string tag = 2
Required. The tag to apply. The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
message
registry_service.proto:783Request message for ListApiSpecRevisions.
string name = 1
Required. The name of the spec to list revisions for.
int32 page_size = 2
The maximum number of revisions to return per page.
string page_token = 3
The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.
message
registry_service.proto:801Response message for ListApiSpecRevisionsResponse.
repeated api_specs = 1
The revisions of the spec.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
message
registry_service.proto:811Request message for RollbackApiSpec.
string name = 1
Required. The spec being rolled back.
string revision_id = 2
Required. The revision ID to roll back to. It must be a revision of the same spec. Example: `c7cfa2a8`
Deletes a revision of a spec.
message
registry_service.proto:828Request message for DeleteApiSpecRevision.
string name = 1
Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`
Returns matching deployments.
message
registry_service.proto:843Request message for ListApiDeployments.
string parent = 1
Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
int32 page_size = 2
The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
string page_token = 3
A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.
string filter = 4
An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
message
registry_service.proto:872Response message for ListApiDeployments.
repeated api_deployments = 1
The deployments from the specified publisher.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Returns a specified deployment.
message
registry_service.proto:882Request message for GetApiDeployment.
string name = 1
Required. The name of the deployment to retrieve. Format: `projects/*/locations/*/apis/*/deployments/*`
Creates a specified deployment.
message
registry_service.proto:894Request message for CreateApiDeployment.
string parent = 1
Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`
optional api_deployment = 2
Required. The deployment to create.
string api_deployment_id = 3
Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.
Used to modify a specified deployment.
message
registry_service.proto:918Request message for UpdateApiDeployment.
optional api_deployment = 1
Required. The deployment to update. The `name` field is used to identify the deployment to update. Format: `projects/*/locations/*/apis/*/deployments/*`
optional update_mask = 2
The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
bool allow_missing = 3
If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
message
registry_service.proto:937Request message for DeleteApiDeployment.
string name = 1
Required. The name of the deployment to delete. Format: `projects/*/locations/*/apis/*/deployments/*`
bool force = 2
If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
Adds a tag to a specified revision of a deployment.
message
registry_service.proto:953Request message for TagApiDeploymentRevision.
string name = 1
Required. The name of the deployment to be tagged, including the revision ID.
string tag = 2
Required. The tag to apply. The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
message
registry_service.proto:968Request message for ListApiDeploymentRevisions.
string name = 1
Required. The name of the deployment to list revisions for.
int32 page_size = 2
The maximum number of revisions to return per page.
string page_token = 3
The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.
message
registry_service.proto:986Response message for ListApiDeploymentRevisionsResponse.
repeated api_deployments = 1
The revisions of the deployment.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
message
registry_service.proto:996Request message for RollbackApiDeployment.
string name = 1
Required. The deployment being rolled back.
string revision_id = 2
Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: `c7cfa2a8`
Deletes a revision of a deployment.
message
registry_service.proto:1013Request message for DeleteApiDeploymentRevision.
string name = 1
Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`
Returns matching artifacts.
message
registry_service.proto:1028Request message for ListArtifacts.
string parent = 1
Required. The parent, which owns this collection of artifacts. Format: `{parent}`
int32 page_size = 2
The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
string page_token = 3
A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
string filter = 4
An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
message
registry_service.proto:1057Response message for ListArtifacts.
repeated artifacts = 1
The artifacts from the specified publisher.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Returns a specified artifact.
message
registry_service.proto:1067Request message for GetArtifact.
string name = 1
Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`
Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
message
registry_service.proto:1079Request message for GetArtifactContents.
string name = 1
Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`
Creates a specified artifact.
message
registry_service.proto:1091Request message for CreateArtifact.
string parent = 1
Required. The parent, which owns this collection of artifacts. Format: `{parent}`
optional artifact = 2
Required. The artifact to create.
string artifact_id = 3
Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. Following AIP-162, IDs must not have the form of a UUID.
Used to replace a specified artifact.
message
registry_service.proto:1115Request message for ReplaceArtifact.
optional artifact = 1
Required. The artifact to replace. The `name` field is used to identify the artifact to replace. Format: `{parent}/artifacts/*`
Removes a specified artifact.
message
registry_service.proto:1124Request message for DeleteArtifact.
string name = 1
Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`
message
registry_models.proto:33A top-level description of an API. Produced by producers and are commitments to provide services.
Used as response type in: Registry.CreateApi, Registry.GetApi, Registry.UpdateApi
Used as field type in: , ,
string name = 1
Resource name.
string display_name = 2
Human-meaningful name.
string description = 3
A detailed description.
optional create_time = 4
Output only. Creation timestamp.
optional update_time = 5
Output only. Last update timestamp.
string availability = 6
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".
string recommended_version = 7
The recommended version of the API. Format: `apis/{api}/versions/{version}`
string recommended_deployment = 8
The recommended deployment of the API. Format: `apis/{api}/deployments/{deployment}`
map<string, string> labels = 9
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.
map<string, string> annotations = 10
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.
message
registry_models.proto:240Describes 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.
Used as response type in: Registry.CreateApiDeployment, Registry.DeleteApiDeploymentRevision, Registry.GetApiDeployment, Registry.RollbackApiDeployment, Registry.TagApiDeploymentRevision, Registry.UpdateApiDeployment
Used as field type in: , , ,
string name = 1
Resource name.
string display_name = 2
Human-meaningful name.
string description = 3
A detailed description.
string revision_id = 4
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.
optional create_time = 5
Output only. Creation timestamp; when the deployment resource was created.
optional revision_create_time = 6
Output only. Revision creation timestamp; when the represented revision was created.
optional revision_update_time = 7
Output only. Last update timestamp: when the represented revision was last modified.
string api_spec_revision = 8
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}`
string endpoint_uri = 9
The address where the deployment is serving. Changes to this value will update the revision.
string external_channel_uri = 10
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
string intended_audience = 11
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
string access_guidance = 12
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
map<string, string> labels = 14
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.
map<string, string> annotations = 15
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.
message
registry_models.proto:152Describes 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.
Used as response type in: Registry.CreateApiSpec, Registry.DeleteApiSpecRevision, Registry.GetApiSpec, Registry.RollbackApiSpec, Registry.TagApiSpecRevision, Registry.UpdateApiSpec
Used as field type in: , , ,
string name = 1
Resource name.
string filename = 2
A possibly-hierarchical name used to refer to the spec from other specs.
string description = 3
A detailed description.
string revision_id = 4
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.
optional create_time = 5
Output only. Creation timestamp; when the spec resource was created.
optional revision_create_time = 6
Output only. Revision creation timestamp; when the represented revision was created.
optional revision_update_time = 7
Output only. Last update timestamp: when the represented revision was last modified.
string mime_type = 8
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").
int32 size_bytes = 9
Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
string hash = 10
Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
string source_uri = 11
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.
bytes contents = 12
Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
map<string, string> labels = 14
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.
map<string, string> annotations = 15
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.
message
registry_models.proto:95Describes a particular version of an API. ApiVersions are what consumers actually use.
Used as response type in: Registry.CreateApiVersion, Registry.GetApiVersion, Registry.UpdateApiVersion
Used as field type in: , ,
string name = 1
Resource name.
string display_name = 2
Human-meaningful name.
string description = 3
A detailed description.
optional create_time = 4
Output only. Creation timestamp.
optional update_time = 5
Output only. Last update timestamp.
string state = 6
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".
map<string, string> labels = 7
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.
map<string, string> annotations = 8
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.
message
registry_models.proto:325Artifacts of resources. Artifacts are unique (single-value) per resource and are used to store metadata that is too large or numerous to be stored directly on the resource. Since artifacts are stored separately from parent resources, they should generally be used for metadata that is needed infrequently, i.e., not for display in primary views of the resource but perhaps displayed or downloaded upon request. The `ListArtifacts` method allows artifacts to be quickly enumerated and checked for presence without downloading their (potentially-large) contents.
Used as response type in: Registry.CreateArtifact, Registry.GetArtifact, Registry.ReplaceArtifact
Used as field type in: , ,
string name = 1
Resource name.
optional create_time = 2
Output only. Creation timestamp.
optional update_time = 3
Output only. Last update timestamp.
string mime_type = 4
A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
int32 size_bytes = 5
Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
string hash = 6
Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
bytes contents = 7
Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
message
provisioning_service.proto:145An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.
Used as response type in: Provisioning.GetInstance
Used as field type in:
string name = 1
Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported.
optional create_time = 2
Output only. Creation timestamp.
optional update_time = 3
Output only. Last update timestamp.
Instance.State state = 4
Output only. The current state of the Instance.
string state_message = 5
Output only. Extra information of Instance.State if the state is `FAILED`.
optional config = 6
Required. Config of the Instance.
message
provisioning_service.proto:176Available configurations to provision an Instance.
Used in:
string location = 1
Output only. The GCP location where the Instance resides.
string cmek_key_name = 2
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.
State of the Instance.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
INACTIVE = 1
The Instance has not been initialized or has been deleted.
CREATING = 2
The Instance is being created.
ACTIVE = 3
The Instance has been created and is ready for use.
UPDATING = 4
The Instance is being updated.
DELETING = 5
The Instance is being deleted.
FAILED = 6
The Instance encountered an error during a state change.
message
provisioning_service.proto:117Represents the metadata of the long-running operation.
optional create_time = 1
The time the operation was created.
optional end_time = 2
The time the operation finished running.
string target = 3
Server-defined resource path for the target of the operation.
string verb = 4
Name of the verb executed by the operation.
string status_message = 5
Human-readable status of the operation, if any.
bool cancellation_requested = 6
Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
string api_version = 7
API version used to start the operation.