Cloud PubSub V1 Client - Class GetSchemaRequest (2.15.1)

Reference documentation and code samples for the Cloud PubSub V1 Client class GetSchemaRequest.

Request for the GetSchema method.

Generated from protobuf message google.pubsub.v1.GetSchemaRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.
↳ view int

The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition.

getName

Required. The name of the schema to get.

Format is projects/{project}/schemas/{schema}.

Returns
Type Description
string

setName

Required. The name of the schema to get.

Format is projects/{project}/schemas/{schema}.

Parameter
Name Description
var string
Returns
Type Description
$this

getView

The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition.

Returns
Type Description
int Enum of type SchemaView.

setView

The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition.

Parameter
Name Description
var int

Enum of type SchemaView.

Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}. Please see SchemaServiceClient::schemaName() for help formatting this field.
Returns
Type Description
GetSchemaRequest