Connectors API . projects . locations . connections . resources

Instance Methods

close()

Close httplib2 connections.

get(name, executionConfig_headers=None, x__xgafv=None)

Gets a specific resource.

getResourcePost(name, body=None, x__xgafv=None)

Gets a specific resource with POST.

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

Lists all available resources.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, executionConfig_headers=None, x__xgafv=None)
Gets a specific resource.

Args:
  name: string, Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource} (required)
  executionConfig_headers: string, headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}'
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "data": "A String", # The content of the resource.
  "metadata": { # Metadata like service latency, etc.
    "a_key": {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  },
  "mimeType": "A String", # The MIME type of the resource.
}
getResourcePost(name, body=None, x__xgafv=None)
Gets a specific resource with POST.

Args:
  name: string, Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ConnectorAgentService.GetResourcePost
  "executionConfig": { # execution config for the request.
    "headers": "A String", # headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}'
  },
  "toolSpec": { # List of tool specifications.
    "toolDefinitions": [ # List of tool definitions.
      {
        "a_key": "", # Properties of the object.
      },
    ],
    "toolSpecVersion": "A String", # Version of the tool spec. Format: providerId/connectorId/versionId/toolSpecId
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "data": "A String", # The content of the resource.
  "metadata": { # Metadata like service latency, etc.
    "a_key": {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  },
  "mimeType": "A String", # The MIME type of the resource.
}
list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all available resources.

Args:
  parent: string, Required. Resource name of the connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
  executionConfig_headers: string, headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}'
  pageSize: integer, Optional. Page size for the request.
  pageToken: string, Optional. Page token for the request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "metadata": { # Metadata like service latency, etc.
    "a_key": {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  },
  "nextPageToken": "A String", # Next page token if more resources available.
  "resources": [ # List of available resources.
    {
      "description": "A String", # A description of what this resource represents.
      "mimeType": "A String", # The MIME type of this resource, if known.
      "name": "A String", # A human-readable name for this resource.
      "size": "A String", # The size of the raw resource content, in bytes, if known.
      "uri": "A String", # The URI of this resource.
    },
  ],
}
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.