Google Cloud Managed Kafka Schema Registry V1 Client - Class ListSubjectsRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Managed Kafka Schema Registry V1 Client class ListSubjectsRequest.

Request for listing subjects.

Generated from protobuf message google.cloud.managedkafka.schemaregistry.v1.ListSubjectsRequest

Namespace

Google \ Cloud \ ManagedKafka \ SchemaRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}
↳ subject_prefix string

Optional. The context to filter the subjects by, in the format of :.{context}:. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
↳ deleted bool

Optional. If true, the response will include soft-deleted subjects. The default is false.

getParent

Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}

Returns
Type Description
string

setParent

Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}

Parameter
Name Description
var string
Returns
Type Description
$this

getSubjectPrefix

Optional. The context to filter the subjects by, in the format of :.{context}:. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.

Returns
Type Description
string

hasSubjectPrefix

clearSubjectPrefix

setSubjectPrefix

Optional. The context to filter the subjects by, in the format of :.{context}:. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeleted

Optional. If true, the response will include soft-deleted subjects. The default is false.

Returns
Type Description
bool

hasDeleted

clearDeleted

setDeleted

Optional. If true, the response will include soft-deleted subjects. The default is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}
subjectPrefix string

Optional. The context to filter the subjects by, in the format of :.{context}:. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
deleted bool

Optional. If true, the response will include soft-deleted subjects. The default is false.
Returns
Type Description
ListSubjectsRequest