Network Services V1 API - Class Google::Cloud::NetworkServices::V1::WasmPluginVersion (v2.10.1)

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::WasmPluginVersion.

A single immutable version of a WasmPlugin resource. Defines the Wasm module used and optionally its runtime config.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A human-readable description of the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A human-readable description of the resource.
Returns
  • (::String) — Optional. A human-readable description of the resource.

#image_digest

def image_digest() -> ::String
Returns
  • (::String) — Output only. This field holds the digest (usually checksum) value for the plugin image. The value is calculated based on the image_uri field. If the image_uri field refers to a container image, the digest value is obtained from the container image. If the image_uri field refers to a generic artifact, the digest value is calculated based on the contents of the file.

#image_uri

def image_uri() -> ::String
Returns
  • (::String) —

    Optional. URI of the image containing the Wasm module, stored in Artifact Registry.

    The URI can refer to one of the following repository formats:

    • Container images: the image_uri must point to a container that contains a single file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the digest of the image is saved in the image_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the image_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the image_digest field.

#image_uri=

def image_uri=(value) -> ::String
Parameter
  • value (::String) —

    Optional. URI of the image containing the Wasm module, stored in Artifact Registry.

    The URI can refer to one of the following repository formats:

    • Container images: the image_uri must point to a container that contains a single file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the digest of the image is saved in the image_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the image_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the image_digest field.

Returns
  • (::String) —

    Optional. URI of the image containing the Wasm module, stored in Artifact Registry.

    The URI can refer to one of the following repository formats:

    • Container images: the image_uri must point to a container that contains a single file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the digest of the image is saved in the image_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the image_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.wasm. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the image_digest field.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the WasmPluginVersion resource.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the WasmPluginVersion resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the WasmPluginVersion resource.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Name of the WasmPluginVersion resource in the following format: projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/\\{wasm_plugin_version}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Name of the WasmPluginVersion resource in the following format: projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/\\{wasm_plugin_version}.
Returns
  • (::String) — Identifier. Name of the WasmPluginVersion resource in the following format: projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/\\{wasm_plugin_version}.

#plugin_config_data

def plugin_config_data() -> ::String
Returns
  • (::String) — Configuration for the plugin. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback. When a new WasmPluginVersion resource is created, the digest of the contents is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_data, plugin_config_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#plugin_config_data=

def plugin_config_data=(value) -> ::String
Parameter
  • value (::String) — Configuration for the plugin. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback. When a new WasmPluginVersion resource is created, the digest of the contents is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_data, plugin_config_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Configuration for the plugin. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback. When a new WasmPluginVersion resource is created, the digest of the contents is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_data, plugin_config_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#plugin_config_digest

def plugin_config_digest() -> ::String
Returns
  • (::String) — Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of plugin_config_data field or the image defined by the plugin_config_uri field.

#plugin_config_uri

def plugin_config_uri() -> ::String
Returns
  • (::String) — URI of the plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback.

    The URI can refer to one of the following repository formats:

    • Container images: the plugin_config_uri must point to a container that contains a single file with the name plugin.config. When a new WasmPluginVersion resource is created, the digest of the image is saved in the plugin_config_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the plugin_config_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.config. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_uri, plugin_config_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#plugin_config_uri=

def plugin_config_uri=(value) -> ::String
Parameter
  • value (::String) — URI of the plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback.

    The URI can refer to one of the following repository formats:

    • Container images: the plugin_config_uri must point to a container that contains a single file with the name plugin.config. When a new WasmPluginVersion resource is created, the digest of the image is saved in the plugin_config_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the plugin_config_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.config. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_uri, plugin_config_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — URI of the plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the ON_CONFIGURE callback.

    The URI can refer to one of the following repository formats:

    • Container images: the plugin_config_uri must point to a container that contains a single file with the name plugin.config. When a new WasmPluginVersion resource is created, the digest of the image is saved in the plugin_config_digest field. When pulling a container image from Artifact Registry, the digest value is used instead of an image tag.

    • Generic artifacts: the plugin_config_uri must be in this format: projects/{project}/locations/{location}/repositories/{repository}/ genericArtifacts/\\{package}:\\{version}. The specified package and version must contain a file with the name plugin.config. When a new WasmPluginVersion resource is created, the checksum of the contents of the file is saved in the plugin_config_digest field.

    Note: The following fields are mutually exclusive: plugin_config_uri, plugin_config_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns