Google Workspace Events API . tasks . pushNotificationConfigs

close()

Close httplib2 connections.

create(parent, body=None, configId=None, tenant=None, x__xgafv=None)

Set a push notification config for a task.

Args:
  parent: string, Required. The parent task resource for this config. Format: tasks/{task_id} (required)
  body: object, The request body.
    The object takes the form of:

{
  "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
  "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
    "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
      "credentials": "A String", # Optional credentials
      "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
        "A String",
      ],
    },
    "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
    "token": "A String", # Token unique for this task/session
    "url": "A String", # Url to send the notification too
  },
}

  configId: string, Required. The ID for the new config.
  tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
  "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
    "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
      "credentials": "A String", # Optional credentials
      "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
        "A String",
      ],
    },
    "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
    "token": "A String", # Token unique for this task/session
    "url": "A String", # Url to send the notification too
  },
}

delete(name, tenant=None, x__xgafv=None)

Delete a push notification config for a task.

Args:
  name: string, The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id} (required)
  tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 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(name, tenant=None, x__xgafv=None)

Get a push notification config for a task.

Args:
  name: string, The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id} (required)
  tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
  "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
    "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
      "credentials": "A String", # Optional credentials
      "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
        "A String",
      ],
    },
    "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
    "token": "A String", # Token unique for this task/session
    "url": "A String", # Url to send the notification too
  },
}

list(parent, pageSize=None, pageToken=None, tenant=None, x__xgafv=None)

Get a list of push notifications configured for a task.

Args:
  parent: string, The parent task resource. Format: tasks/{task_id} (required)
  pageSize: integer, For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.
  pageToken: string, A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.
  tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "configs": [ # The list of push notification configurations.
    {
      "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
      "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
        "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
          "credentials": "A String", # Optional credentials
          "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
            "A String",
          ],
        },
        "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
        "token": "A String", # Token unique for this task/session
        "url": "A String", # Url to send the notification too
      },
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

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.