# Google Cloud Pub/Sub API . projects . topics

## Instance Methods

Returns the subscriptions Resource.

Creates the given topic with the given name.

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.

Gets the configuration of a topic.

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Lists matching topics.

Retrieves the next page of results.

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

Sets the access control policy on the specified resource. Replaces any existing policy.

Returns permissions that a caller has on the specified resource.

### Method Details

`create(name, body, x__xgafv=None)`

    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}" for Google Cloud Pub/Sub API v1beta2. {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}" for Google Cloud Pub/Sub API v1beta2. {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}" for Google Cloud Pub/Sub API v1beta2. {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".
      }

`delete(topic, x__xgafv=None)`

    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.

    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); }
      }

`get(topic, x__xgafv=None)`

    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}" for Google Cloud Pub/Sub API v1beta2. {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".
      }

`getIamPolicy(resource, x__xgafv=None)`

    Gets the access control policy for a resource. May be empty if no such policy or resource exists.

    Args:
      resource: string, REQUIRED: The resource for which policy is being requested. Usually some path like 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 can be used to define policies that can be 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 can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check 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"] } ] } ```
        "rules": [
          { # A rule to be applied in a Policy.
            "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
              "A String",
            ],
            "description": "A String", # Human-readable description of the rule.
            "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
              "A String",
            ],
            "action": "A String", # Required
            "conditions": [ # Additional restrictions that must be met
              { # A condition to be met.
                "iam": "A String", # Trusted attributes supplied by the IAM system.
                "svc": "A String", # Trusted attributes discharged by the service.
                "value": "A String", # The object of the condition. Exactly one of these must be set.
                "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
                "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
                  "A String",
                ],
                "op": "A String", # An operator to apply the subject with.
              },
            ],
            "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
              { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
                "counter": { # Options for counters # Counter options.
                  "field": "A String", # The field value to attribute.
                  "metric": "A String", # The metric to update.
                },
                "dataAccess": { # Write a Data Access (Gin) log # Data access options.
                },
                "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
                },
              },
            ],
            "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
              "A String",
            ],
          },
        ],
        "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 of various types with roles. See below for details of the various objects that can be included as 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 itself is represented by the etag. The current version is 0.
        "etag": "A String", # Can be used to perform a read-modify-write.
      }

`list(project, pageSize=None, pageToken=None, x__xgafv=None)`

    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}" for Google Cloud Pub/Sub API v1beta2. {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".
          },
        ],
      }

`list_next(previous_request, previous_response)`

    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.

`publish(topic, body, x__xgafv=None)`

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

    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.
            "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",
        ],
      }

`setIamPolicy(resource, body, x__xgafv=None)`

    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. Usually some path like 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 can be used to define policies that can be 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 can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check 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.
          "rules": [
            { # A rule to be applied in a Policy.
              "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
                "A String",
              ],
              "description": "A String", # Human-readable description of the rule.
              "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
                "A String",
              ],
              "action": "A String", # Required
              "conditions": [ # Additional restrictions that must be met
                { # A condition to be met.
                  "iam": "A String", # Trusted attributes supplied by the IAM system.
                  "svc": "A String", # Trusted attributes discharged by the service.
                  "value": "A String", # The object of the condition. Exactly one of these must be set.
                  "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
                  "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
                    "A String",
                  ],
                  "op": "A String", # An operator to apply the subject with.
                },
              ],
              "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
                { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
                  "counter": { # Options for counters # Counter options.
                    "field": "A String", # The field value to attribute.
                    "metric": "A String", # The metric to update.
                  },
                  "dataAccess": { # Write a Data Access (Gin) log # Data access options.
                  },
                  "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
                  },
                },
              ],
              "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
                "A String",
              ],
            },
          ],
          "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 of various types with roles. See below for details of the various objects that can be included as 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 itself is represented by the etag. The current 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 can be used to define policies that can be 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 can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check 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"] } ] } ```
        "rules": [
          { # A rule to be applied in a Policy.
            "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
              "A String",
            ],
            "description": "A String", # Human-readable description of the rule.
            "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
              "A String",
            ],
            "action": "A String", # Required
            "conditions": [ # Additional restrictions that must be met
              { # A condition to be met.
                "iam": "A String", # Trusted attributes supplied by the IAM system.
                "svc": "A String", # Trusted attributes discharged by the service.
                "value": "A String", # The object of the condition. Exactly one of these must be set.
                "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
                "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
                  "A String",
                ],
                "op": "A String", # An operator to apply the subject with.
              },
            ],
            "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
              { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
                "counter": { # Options for counters # Counter options.
                  "field": "A String", # The field value to attribute.
                  "metric": "A String", # The metric to update.
                },
                "dataAccess": { # Write a Data Access (Gin) log # Data access options.
                },
                "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
                },
              },
            ],
            "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
              "A String",
            ],
          },
        ],
        "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 of various types with roles. See below for details of the various objects that can be included as 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 itself is represented by the etag. The current version is 0.
        "etag": "A String", # Can be used to perform a read-modify-write.
      }

`testIamPermissions(resource, body, x__xgafv=None)`

    Returns permissions that a caller has on the specified resource.

    Args:
      resource: string, REQUIRED: The resource for which policy detail is being requested. Usually some path like 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",
        ],
      }