Class ProjectsResource.TopicsResource

The "topics" collection of methods.

Inheritance

object

ProjectsResource.TopicsResource

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.TopicsResource

Constructors

TopicsResource(IClientService)

Constructs a new resource.

Declaration

public TopicsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Snapshots

Gets the Snapshots resource.

Declaration

public virtual ProjectsResource.TopicsResource.SnapshotsResource Snapshots { get; }

Property Value

Type	Description
ProjectsResource.TopicsResource.SnapshotsResource

Subscriptions

Gets the Subscriptions resource.

Declaration

public virtual ProjectsResource.TopicsResource.SubscriptionsResource Subscriptions { get; }

Property Value

Type	Description
ProjectsResource.TopicsResource.SubscriptionsResource

Methods

Create(Topic, string)

Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).

Declaration

public virtual ProjectsResource.TopicsResource.CreateRequest Create(Topic body, string name)

Parameters

Type	Name	Description
Topic	body	The body of the request.
string	name	Required. The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Returns

Type	Description
ProjectsResource.TopicsResource.CreateRequest

Delete(string)

Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to _deleted-topic_.

Declaration

public virtual ProjectsResource.TopicsResource.DeleteRequest Delete(string topic)

Parameters

Type	Name	Description
string	topic	Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.

Returns

Type	Description
ProjectsResource.TopicsResource.DeleteRequest

Get(string)

Gets the configuration of a topic.

Declaration

public virtual ProjectsResource.TopicsResource.GetRequest Get(string topic)

Parameters

Type	Name	Description
string	topic	Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.

Returns

Type	Description
ProjectsResource.TopicsResource.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.TopicsResource.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.TopicsResource.GetIamPolicyRequest

List(string)

Lists matching topics.

Declaration

public virtual ProjectsResource.TopicsResource.ListRequest List(string project)

Parameters

Type	Name	Description
string	project	Required. The name of the project in which to list topics. Format is projects/{project-id}.

Returns

Type	Description
ProjectsResource.TopicsResource.ListRequest

Patch(UpdateTopicRequest, string)

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

Declaration

public virtual ProjectsResource.TopicsResource.PatchRequest Patch(UpdateTopicRequest body, string name)

Parameters

Type	Name	Description
UpdateTopicRequest	body	The body of the request.
string	name	Required. The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Returns

Type	Description
ProjectsResource.TopicsResource.PatchRequest

Publish(PublishRequest, string)

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Declaration

public virtual ProjectsResource.TopicsResource.PublishRequest Publish(PublishRequest body, string topic)

Parameters

Type	Name	Description
PublishRequest	body	The body of the request.
string	topic	Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

Returns

Type	Description
ProjectsResource.TopicsResource.PublishRequest

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.TopicsResource.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.TopicsResource.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.TopicsResource.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.TopicsResource.TestIamPermissionsRequest