com.google.api.services.pubsub

Class Pubsub.Projects.Schemas

java.lang.Object

com.google.api.services.pubsub.Pubsub.Projects.Schemas

Enclosing class:

Pubsub.Projects

public class Pubsub.Projects.Schemas
extends Object

The "schemas" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Pubsub.Projects.Schemas.Create
class	Pubsub.Projects.Schemas.Delete
class	Pubsub.Projects.Schemas.Get
class	Pubsub.Projects.Schemas.GetIamPolicy
class	Pubsub.Projects.Schemas.List
class	Pubsub.Projects.Schemas.SetIamPolicy
class	Pubsub.Projects.Schemas.TestIamPermissions
class	Pubsub.Projects.Schemas.Validate
class	Pubsub.Projects.Schemas.ValidateMessage

Constructor Summary

Constructors

Constructor and Description
Schemas()

Method Summary

Modifier and Type	Method and Description
Pubsub.Projects.Schemas.Create	create(String parent, Schema content) Creates a schema.
Pubsub.Projects.Schemas.Delete	delete(String name) Deletes a schema.
Pubsub.Projects.Schemas.Get	get(String name) Gets a schema.
Pubsub.Projects.Schemas.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
Pubsub.Projects.Schemas.List	list(String parent) Lists schemas in a project.
Pubsub.Projects.Schemas.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
Pubsub.Projects.Schemas.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
Pubsub.Projects.Schemas.Validate	validate(String parent, ValidateSchemaRequest content) Validates a schema.
Pubsub.Projects.Schemas.ValidateMessage	validateMessage(String parent, ValidateMessageRequest content) Validates a message against a schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Schemas

public Schemas()

Method Detail

create

public Pubsub.Projects.Schemas.Create create(String parent,
                                             Schema content)
                                      throws IOException

Creates a schema. Create a request for the method "schemas.create". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the Schema

Returns:

the request

Throws:

IOException

delete

public Pubsub.Projects.Schemas.Delete delete(String name)
                                      throws IOException

Deletes a schema. Create a request for the method "schemas.delete". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

get

public Pubsub.Projects.Schemas.Get get(String name)
                                throws IOException

Gets a schema. Create a request for the method "schemas.get". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

getIamPolicy

public Pubsub.Projects.Schemas.GetIamPolicy getIamPolicy(String resource)
                                                  throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "schemas.getIamPolicy". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

public Pubsub.Projects.Schemas.List list(String parent)
                                  throws IOException

Lists schemas in a project. Create a request for the method "schemas.list". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

setIamPolicy

public Pubsub.Projects.Schemas.SetIamPolicy setIamPolicy(String resource,
                                                         SetIamPolicyRequest content)
                                                  throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "schemas.setIamPolicy". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Pubsub.Projects.Schemas.TestIamPermissions testIamPermissions(String resource,
                                                                     TestIamPermissionsRequest content)
                                                              throws IOException

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. Create a request for the method "schemas.testIamPermissions". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

validate

public Pubsub.Projects.Schemas.Validate validate(String parent,
                                                 ValidateSchemaRequest content)
                                          throws IOException

Validates a schema. Create a request for the method "schemas.validate". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the ValidateSchemaRequest

Returns:

the request

Throws:

IOException

validateMessage

public Pubsub.Projects.Schemas.ValidateMessage validateMessage(String parent,
                                                               ValidateMessageRequest content)
                                                        throws IOException

Validates a message against a schema. Create a request for the method "schemas.validateMessage". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the ValidateMessageRequest

Returns:

the request

Throws:

IOException