Reference documentation and code samples for the Google Cloud Managed Kafka Schema Registry V1 Client class DeleteVersionRequest.
Request for DeleteVersion.
Generated from protobuf message google.cloud.managedkafka.schemaregistry.v1.DeleteVersionRequest
Namespace
Google \ Cloud \ ManagedKafka \ SchemaRegistry \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the subject version to delete. Structured like: |
↳ permanent |
bool
Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete. |
getName
Required. The name of the subject version to delete. Structured like:
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}
or
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
Returns | |
---|---|
Type | Description |
string |
setName
Required. The name of the subject version to delete. Structured like:
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}
or
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPermanent
Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
Returns | |
---|---|
Type | Description |
bool |
hasPermanent
clearPermanent
setPermanent
Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
name |
string
Required. The name of the subject version to delete. Structured like:
|
Returns | |
---|---|
Type | Description |
DeleteVersionRequest |