Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class Artifact.
Artifacts 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.
Generated from protobuf message google.cloud.apigeeregistry.v1.Artifact
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Resource name. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Last update timestamp. |
↳ mime_type |
string
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"). |
↳ size_bytes |
int
Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact. |
↳ hash |
string
Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact. |
↳ contents |
string
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. |
getName
Resource name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Creation timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Last update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMimeType
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").
| Returns | |
|---|---|
| Type | Description |
string | |
setMimeType
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").
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSizeBytes
Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
| Returns | |
|---|---|
| Type | Description |
int | |
setSizeBytes
Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHash
Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
| Returns | |
|---|---|
| Type | Description |
string | |
setHash
Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContents
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setContents
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |