Connectors API . projects . locations . connections . runtimeActionSchemas

Instance Methods

close()

Close httplib2 connections.

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

List schema of a runtime actions filtered by action name.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List schema of a runtime actions filtered by action name.

Args:
  parent: string, Required. Parent resource of RuntimeActionSchema Format: projects/{project}/locations/{location}/connections/{connection} (required)
  filter: string, Required. Filter Format: action="{actionId}" Only action field is supported with literal equality operator. Accepted filter example: action="CancelOrder" Wildcards are not supported in the filter currently.
  pageSize: integer, Page size.
  pageToken: string, Page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ConnectorsService.ListRuntimeActionSchemas.
  "nextPageToken": "A String", # Next page token.
  "runtimeActionSchemas": [ # Runtime action schemas.
    { # Schema of a runtime action.
      "action": "A String", # Output only. Name of the action.
      "inputParameters": [ # Output only. List of input parameter metadata for the action.
        { # Metadata of an input parameter.
          "dataType": "A String", # The data type of the Parameter.
          "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided.
          "description": "A String", # A brief description of the Parameter.
          "nullable": True or False, # Specifies whether a null value is allowed.
          "parameter": "A String", # Name of the Parameter.
        },
      ],
      "resultMetadata": [ # Output only. List of result field metadata.
        { # Metadata of result field.
          "dataType": "A String", # The data type of the field.
          "description": "A String", # A brief description of the field.
          "field": "A String", # Name of the result field.
        },
      ],
    },
  ],
}
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.