docs/dyn/pubsub_v1.projects.topics.html - platform/external/python/google-api-python-client - Gitiles

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="pubsub_v1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.topics.html">topics</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="pubsub_v1.projects.topics.subscriptions.html">subscriptions()</a></code>
 </p>
 <p class="firstline">Returns the subscriptions Resource.</p>

 <p class="toc_element">
   <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates the given topic with the given name.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
 <p class="firstline">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_`.</p>
 <p class="toc_element">
   <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets the configuration of a topic.</p>
 <p class="toc_element">
   <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.</p>
 <p class="toc_element">
   <code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists matching topics.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <p class="toc_element">
   <code><a href="#publish">publish(topic, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
 <p class="toc_element">
   <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
 <p class="toc_element">
   <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="create">create(name, body, x__xgafv=None)</code>
   <pre>Creates the given topic with the given name.

 Args:
   name: string, 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"`. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # A topic resource.
   "name": "A String", # 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"`.
 }

   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # A topic resource.
     "name": "A String", # 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"`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
   <pre>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_`.

 Args:
   topic: string, Name of the topic to delete. (required)
   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(topic, x__xgafv=None)</code>
   <pre>Gets the configuration of a topic.

 Args:
   topic: string, The name of the topic to get. (required)
   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # A topic resource.
     "name": "A String", # 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"`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
   <pre>Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

 Args:
   resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
     "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
       { # Associates members with roles. See below for allowed formats of members.
         "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
         "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
           "A String",
         ],
       },
     ],
     "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
     "etag": "A String", # Can be used to perform a read-modify-write.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
   <pre>Lists matching topics.

 Args:
   project: string, The name of the cloud project that topics belong to. (required)
   pageSize: integer, Maximum number of topics to return.
   pageToken: string, The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.
   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # Response for the ListTopics method.
     "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.
     "topics": [ # The resulting topics.
       { # A topic resource.
         "name": "A String", # 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"`.
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 <div class="method">
     <code class="details" id="publish">publish(topic, body, x__xgafv=None)</code>
   <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

 Args:
   topic: string, The messages in the request will be published on this topic. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Request for the Publish method.
     "messages": [ # The messages to publish.
       { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
         "attributes": { # Optional attributes for this message.
           "a_key": "A String",
         },
         "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
         "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
       },
     ],
   }

   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # Response for the Publish method.
     "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
       "A String",
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
   <pre>Sets the access control policy on the specified resource. Replaces any existing policy.

 Args:
   resource: string, REQUIRED: The resource for which policy is being specified. Resource is usually specified as a path, such as, projects/{project}/zones/{zone}/disks/{disk}. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Request message for `SetIamPolicy` method.
     "policy": { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
       "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
         { # Associates members with roles. See below for allowed formats of members.
           "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
           "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
             "A String",
           ],
         },
       ],
       "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
       "etag": "A String", # Can be used to perform a read-modify-write.
     },
   }

   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
     "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
       { # Associates members with roles. See below for allowed formats of members.
         "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
         "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
           "A String",
         ],
       },
     ],
     "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
     "etag": "A String", # Can be used to perform a read-modify-write.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
   <pre>Returns permissions that a caller has on the specified resource.

 Args:
   resource: string, REQUIRED: The resource for which policy detail is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Request message for `TestIamPermissions` method.
     "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
       "A String",
     ],
   }

   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # Response message for `TestIamPermissions` method.
     "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
       "A String",
     ],
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="pubsub_v1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.topics.html">topics</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="pubsub_v1.projects.topics.subscriptions.html">subscriptions()</a></code>
	</p>
	<p class="firstline">Returns the subscriptions Resource.</p>

	<p class="toc_element">
	<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates the given topic with the given name.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
	<p class="firstline">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_`.</p>
	<p class="toc_element">
	<code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets the configuration of a topic.</p>
	<p class="toc_element">
	<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.</p>
	<p class="toc_element">
	<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists matching topics.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<p class="toc_element">
	<code><a href="#publish">publish(topic, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
	<p class="toc_element">
	<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
	<p class="toc_element">
	<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="create">create(name, body, x__xgafv=None)</code>
	<pre>Creates the given topic with the given name.

	Args:
	name: string, 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"`. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # A topic resource.
	"name": "A String", # 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"`.
	}

	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # A topic resource.
	"name": "A String", # 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"`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(topic, x__xgafv=None)</code>
	<pre>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_`.

	Args:
	topic: string, Name of the topic to delete. (required)
	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(topic, x__xgafv=None)</code>
	<pre>Gets the configuration of a topic.

	Args:
	topic: string, The name of the topic to get. (required)
	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # A topic resource.
	"name": "A String", # 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"`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
	<pre>Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

	Args:
	resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
	"bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
	{ # Associates members with roles. See below for allowed formats of members.
	"role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
	"members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
	"A String",
	],
	},
	],
	"version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
	"etag": "A String", # Can be used to perform a read-modify-write.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
	<pre>Lists matching topics.

	Args:
	project: string, The name of the cloud project that topics belong to. (required)
	pageSize: integer, Maximum number of topics to return.
	pageToken: string, The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.
	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # Response for the ListTopics method.
	"nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.
	"topics": [ # The resulting topics.
	{ # A topic resource.
	"name": "A String", # 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"`.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	<div class="method">
	<code class="details" id="publish">publish(topic, body, x__xgafv=None)</code>
	<pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

	Args:
	topic: string, The messages in the request will be published on this topic. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Request for the Publish method.
	"messages": [ # The messages to publish.
	{ # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
	"attributes": { # Optional attributes for this message.
	"a_key": "A String",
	},
	"data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
	"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
	},
	],
	}

	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # Response for the Publish method.
	"messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
	"A String",
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
	<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

	Args:
	resource: string, REQUIRED: The resource for which policy is being specified. Resource is usually specified as a path, such as, projects/{project}/zones/{zone}/disks/{disk}. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Request message for `SetIamPolicy` method.
	"policy": { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
	"bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
	{ # Associates members with roles. See below for allowed formats of members.
	"role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
	"members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
	"A String",
	],
	},
	],
	"version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
	"etag": "A String", # Can be used to perform a read-modify-write.
	},
	}

	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
	"bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
	{ # Associates members with roles. See below for allowed formats of members.
	"role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
	"members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
	"A String",
	],
	},
	],
	"version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
	"etag": "A String", # Can be used to perform a read-modify-write.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
	<pre>Returns permissions that a caller has on the specified resource.

	Args:
	resource: string, REQUIRED: The resource for which policy detail is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Request message for `TestIamPermissions` method.
	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
	"A String",
	],
	}

	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # Response message for `TestIamPermissions` method.
	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
	"A String",
	],
	}</pre>
	</div>

	</body></html>