Cloud PubSub V1 Client - Class CreateSchemaRequest (1.47.0)

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

Request for the CreateSchema method.

Generated from protobuf message google.pubsub.v1.CreateSchemaRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

โ†ณ parent string

Required. The name of the project in which to create the schema. Format is projects/{project-id}.

โ†ณ schema Google\Cloud\PubSub\V1\Schema

Required. The schema object to create. This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

โ†ณ schema_id string

The ID to use for the schema, which will become the final component of the schema's resource name. See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

getParent

Required. The name of the project in which to create the schema.

Format is projects/{project-id}.

Returns
Type Description
string

setParent

Required. The name of the project in which to create the schema.

Format is projects/{project-id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSchema

Required. The schema object to create.

This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

Returns
Type Description
Google\Cloud\PubSub\V1\Schema|null

hasSchema

clearSchema

setSchema

Required. The schema object to create.

This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

Parameter
Name Description
var Google\Cloud\PubSub\V1\Schema
Returns
Type Description
$this

getSchemaId

The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Returns
Type Description
string

setSchemaId

The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The name of the project in which to create the schema. Format is projects/{project-id}. Please see Google\Cloud\PubSub\V1\SchemaServiceClient::projectName() for help formatting this field.

schema Google\Cloud\PubSub\V1\Schema

Required. The schema object to create.

This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

schemaId string

The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Returns
Type Description
Google\Cloud\PubSub\V1\CreateSchemaRequest