1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Pubsub
  7. \
  8. Resource
  9. \
  10. ProjectsSchemas

ProjectsSchemas

class ProjectsSchemas extends Resource (View source)

The "schemas" collection of methods.

Typical usage is:

 $pubsubService = new Google\Service\Pubsub(...);
 $schemas = $pubsubService->projects_schemas;

Methods

Schema
commit(string $name, CommitSchemaRequest $postBody, array $optParams = [])

Commits a new schema revision to an existing schema. (schemas.commit)

Schema
create(string $parent, Schema $postBody, array $optParams = [])

Creates a schema. (schemas.create)

PubsubEmpty
delete(string $name, array $optParams = [])

Deletes a schema. (schemas.delete)

Schema
deleteRevision(string $name, array $optParams = [])

Deletes a specific schema revision. (schemas.deleteRevision)

Schema
get(string $name, array $optParams = [])

Gets a schema. (schemas.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (schemas.getIamPolicy)

ListSchemasResponse
listProjectsSchemas(string $parent, array $optParams = [])

Lists schemas in a project. (schemas.listProjectsSchemas)

ListSchemaRevisionsResponse
listRevisions(string $name, array $optParams = [])

Lists all schema revisions for the named schema. (schemas.listRevisions)

Schema
rollback(string $name, RollbackSchemaRequest $postBody, array $optParams = [])

Creates a new schema revision that is a copy of the provided revision_id.

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (schemas.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

ValidateSchemaResponse
validate(string $parent, ValidateSchemaRequest $postBody, array $optParams = [])

Validates a schema. (schemas.validate)

ValidateMessageResponse
validateMessage(string $parent, ValidateMessageRequest $postBody, array $optParams = [])

Validates a message against a schema. (schemas.validateMessage)

Details

at line 55
Schema commit(string $name, CommitSchemaRequest $postBody, array $optParams = [])

Commits a new schema revision to an existing schema. (schemas.commit)

Parameters

string $name

Required. The name of the schema we are revising. Format is projects/{project}/schemas/{schema}.
CommitSchemaRequest $postBody
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 76
Schema create(string $parent, Schema $postBody, array $optParams = [])

Creates a schema. (schemas.create)

Parameters

string $parent

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

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 91
PubsubEmpty delete(string $name, array $optParams = [])

Deletes a schema. (schemas.delete)

Parameters

string $name

Required. Name of the schema to delete. Format is projects/{project}/schemas/{schema}.
array $optParams

Optional parameters.

Return Value

PubsubEmpty

Exceptions

Exception

at line 111
Schema deleteRevision(string $name, array $optParams = [])

Deletes a specific schema revision. (schemas.deleteRevision)

Parameters

string $name

Required. The name of the schema revision to be deleted, with a revision ID explicitly included. Example: projects/123/schemas/my- schema@c7cfa2a8
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 130
Schema get(string $name, array $optParams = [])

Gets a schema. (schemas.get)

Parameters

string $name

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 161
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (schemas.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 184
ListSchemasResponse listProjectsSchemas(string $parent, array $optParams = [])

Lists schemas in a project. (schemas.listProjectsSchemas)

Parameters

string $parent

Required. The name of the project in which to list schemas. Format is projects/{project-id}.
array $optParams

Optional parameters.

Return Value

ListSchemasResponse

Exceptions

Exception

at line 205
ListSchemaRevisionsResponse listRevisions(string $name, array $optParams = [])

Lists all schema revisions for the named schema. (schemas.listRevisions)

Parameters

string $name

Required. The name of the schema to list revisions for.
array $optParams

Optional parameters.

Return Value

ListSchemaRevisionsResponse

Exceptions

Exception

at line 221
Schema rollback(string $name, RollbackSchemaRequest $postBody, array $optParams = [])

Creates a new schema revision that is a copy of the provided revision_id.

(schemas.rollback)

Parameters

string $name

Required. The schema being rolled back with revision id.
RollbackSchemaRequest $postBody
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 241
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (schemas.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 263
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (schemas.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

at line 279
ValidateSchemaResponse validate(string $parent, ValidateSchemaRequest $postBody, array $optParams = [])

Validates a schema. (schemas.validate)

Parameters

string $parent

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
ValidateSchemaRequest $postBody
array $optParams

Optional parameters.

Return Value

ValidateSchemaResponse

Exceptions

Exception

at line 295
ValidateMessageResponse validateMessage(string $parent, ValidateMessageRequest $postBody, array $optParams = [])

Validates a message against a schema. (schemas.validateMessage)

Parameters

string $parent

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
ValidateMessageRequest $postBody
array $optParams

Optional parameters.

Return Value

ValidateMessageResponse

Exceptions

Exception