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

AdminProjectsLocationsTopics

class AdminProjectsLocationsTopics extends Resource (View source)

The "topics" collection of methods.

Typical usage is:

 $pubsubliteService = new Google\Service\PubsubLite(...);
 $topics = $pubsubliteService->admin_projects_locations_topics;

Methods

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

Creates a new topic. (topics.create)

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

Deletes the specified topic. (topics.delete)

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

Returns the topic configuration. (topics.get)

TopicPartitions
getPartitions(string $name, array $optParams = [])

Returns the partition information for the requested topic.

ListTopicsResponse
listAdminProjectsLocationsTopics(string $parent, array $optParams = [])

Returns the list of topics for the given project.

Topic
patch(string $name, Topic $postBody, array $optParams = [])

Updates properties of the specified topic. (topics.patch)

Details

at line 49
Topic create(string $parent, Topic $postBody, array $optParams = [])

Creates a new topic. (topics.create)

Parameters

string $parent

Required. The parent location in which to create the topic. Structured like projects/{project_number}/locations/{location}.
Topic $postBody
array $optParams

Optional parameters.

Return Value

Topic

Exceptions

Exception

at line 63
PubsubliteEmpty delete(string $name, array $optParams = [])

Deletes the specified topic. (topics.delete)

Parameters

string $name

Required. The name of the topic to delete.
array $optParams

Optional parameters.

Return Value

PubsubliteEmpty

Exceptions

Exception

at line 78
Topic get(string $name, array $optParams = [])

Returns the topic configuration. (topics.get)

Parameters

string $name

Required. The name of the topic whose configuration to return.
array $optParams

Optional parameters.

Return Value

Topic

Exceptions

Exception

at line 94
TopicPartitions getPartitions(string $name, array $optParams = [])

Returns the partition information for the requested topic.

(topics.getPartitions)

Parameters

string $name

Required. The topic whose partition information to return.
array $optParams

Optional parameters.

Return Value

TopicPartitions

Exceptions

Exception

at line 118
ListTopicsResponse listAdminProjectsLocationsTopics(string $parent, array $optParams = [])

Returns the list of topics for the given project.

(topics.listAdminProjectsLocationsTopics)

Parameters

string $parent

Required. The parent whose topics are to be listed. Structured like projects/{project_number}/locations/{location}.
array $optParams

Optional parameters.

Return Value

ListTopicsResponse

Exceptions

Exception

at line 137
Topic patch(string $name, Topic $postBody, array $optParams = [])

Updates properties of the specified topic. (topics.patch)

Parameters

string $name

The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
Topic $postBody
array $optParams

Optional parameters.

Return Value

Topic

Exceptions

Exception