Show / Hide Table of Contents

Class ProjectsResource.SchemasResource

The "schemas" collection of methods.

Inheritance
object
ProjectsResource.SchemasResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Pubsub.v1
Assembly: Google.Apis.Pubsub.v1.dll
Syntax
public class ProjectsResource.SchemasResource

Constructors

SchemasResource(IClientService)

Constructs a new resource.

Declaration
public SchemasResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Commit(CommitSchemaRequest, string)

Commits a new schema revision to an existing schema.

Declaration
public virtual ProjectsResource.SchemasResource.CommitRequest Commit(CommitSchemaRequest body, string name)
Parameters
Type Name Description
CommitSchemaRequest body

The body of the request.

string name

Required. The name of the schema we are revising. Format is projects/{project}/schemas/{schema}.

Returns
Type Description
ProjectsResource.SchemasResource.CommitRequest

Create(Schema, string)

Creates a schema.

Declaration
public virtual ProjectsResource.SchemasResource.CreateRequest Create(Schema body, string parent)
Parameters
Type Name Description
Schema body

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.SchemasResource.CreateRequest

Delete(string)

Deletes a schema.

Declaration
public virtual ProjectsResource.SchemasResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.SchemasResource.DeleteRequest

DeleteRevision(string)

Deletes a specific schema revision.

Declaration
public virtual ProjectsResource.SchemasResource.DeleteRevisionRequest DeleteRevision(string name)
Parameters
Type Name Description
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

Returns
Type Description
ProjectsResource.SchemasResource.DeleteRevisionRequest

Get(string)

Gets a schema.

Declaration
public virtual ProjectsResource.SchemasResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.SchemasResource.GetRequest

GetIamPolicy(string)

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

Declaration
public virtual ProjectsResource.SchemasResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

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

Returns
Type Description
ProjectsResource.SchemasResource.GetIamPolicyRequest

List(string)

Lists schemas in a project.

Declaration
public virtual ProjectsResource.SchemasResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

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

Returns
Type Description
ProjectsResource.SchemasResource.ListRequest

ListRevisions(string)

Lists all schema revisions for the named schema.

Declaration
public virtual ProjectsResource.SchemasResource.ListRevisionsRequest ListRevisions(string name)
Parameters
Type Name Description
string name

Required. The name of the schema to list revisions for.

Returns
Type Description
ProjectsResource.SchemasResource.ListRevisionsRequest

Rollback(RollbackSchemaRequest, string)

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

Declaration
public virtual ProjectsResource.SchemasResource.RollbackRequest Rollback(RollbackSchemaRequest body, string name)
Parameters
Type Name Description
RollbackSchemaRequest body

The body of the request.

string name

Required. The schema being rolled back with revision id.

Returns
Type Description
ProjectsResource.SchemasResource.RollbackRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration
public virtual ProjectsResource.SchemasResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.SchemasResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration
public virtual ProjectsResource.SchemasResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

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

Returns
Type Description
ProjectsResource.SchemasResource.TestIamPermissionsRequest

Validate(ValidateSchemaRequest, string)

Validates a schema.

Declaration
public virtual ProjectsResource.SchemasResource.ValidateRequest Validate(ValidateSchemaRequest body, string parent)
Parameters
Type Name Description
ValidateSchemaRequest body

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.SchemasResource.ValidateRequest

ValidateMessage(ValidateMessageRequest, string)

Validates a message against a schema.

Declaration
public virtual ProjectsResource.SchemasResource.ValidateMessageRequest ValidateMessage(ValidateMessageRequest body, string parent)
Parameters
Type Name Description
ValidateMessageRequest body

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.SchemasResource.ValidateMessageRequest
In this article
Back to top Generated by DocFX