Connectors API . projects . locations . connections . actions

close()

Close httplib2 connections.

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

Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.

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

{ # Request message for ActionService.ExecuteAction
  "parameters": { # Parameters for executing the action. The parameters can be key/value pairs or nested structs.
    "a_key": "", # Properties of the object.
  },
}

  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 ActionService.ExecuteAction
  "results": [ # In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results': [{'key': 'value'}, ...] }
    {
      "a_key": "", # Properties of the object.
    },
  ],
}

get(name, x__xgafv=None)

Gets the schema of the given action.

Args:
  name: string, Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Action message contains metadata information about a single action present in the external system.
  "description": "A String", # Brief Description of action
  "displayName": "A String", # Display Name of action to be shown on client side
  "inputJsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this actions's input schema
    "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
      "a_key": "", # Properties of the object.
    },
    "default": "", # The default value of the field or object described by this schema.
    "description": "A String", # A description of this schema.
    "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
      "",
    ],
    "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
    "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
    "jdbcType": "A String", # JDBC datatype of the field.
    "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
      "a_key": # Object with schema name: JsonSchema
    },
    "required": [ # Whether this property is required.
      "A String",
    ],
    "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
      "A String",
    ],
  },
  "inputParameters": [ # List containing input parameter metadata.
    { # Input Parameter message contains metadata about the parameters required for executing an Action.
      "additionalDetails": { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
        "a_key": "", # Properties of the object.
      },
      "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.
      "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the parameter, applicable only if parameter is of type `STRUCT`
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        "jdbcType": "A String", # JDBC datatype of the field.
        "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          "a_key": # Object with schema name: JsonSchema
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
      "name": "A String", # Name of the Parameter.
      "nullable": True or False, # Specifies whether a null value is allowed.
    },
  ],
  "name": "A String", # Name of the action.
  "resultJsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this actions's result schema
    "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
      "a_key": "", # Properties of the object.
    },
    "default": "", # The default value of the field or object described by this schema.
    "description": "A String", # A description of this schema.
    "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
      "",
    ],
    "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
    "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
    "jdbcType": "A String", # JDBC datatype of the field.
    "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
      "a_key": # Object with schema name: JsonSchema
    },
    "required": [ # Whether this property is required.
      "A String",
    ],
    "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
      "A String",
    ],
  },
  "resultMetadata": [ # List containing the metadata of result fields.
    { # Result Metadata message contains metadata about the result returned after executing an Action.
      "dataType": "A String", # The data type of the metadata field
      "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 metadata field.
      "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT`
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        "jdbcType": "A String", # JDBC datatype of the field.
        "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          "a_key": # Object with schema name: JsonSchema
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
      "name": "A String", # Name of the metadata field.
      "nullable": True or False, # Specifies whether a null value is allowed.
    },
  ],
}

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

Gets the schema of all the actions supported by the connector.

Args:
  parent: string, Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection} (required)
  pageSize: integer, Number of Actions to return. Defaults to 25.
  pageToken: string, Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions.
  view: string, Specifies which fields of the Action are returned in the response.
    Allowed values
      ACTION_VIEW_UNSPECIFIED - VIEW_UNSPECIFIED. The unset value Defaults to FULL View.
      ACTION_VIEW_BASIC - Return only action names.
      ACTION_VIEW_FULL - Return actions with schema.
  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 ActionService.ListActions
  "actions": [ # List of action metadata.
    { # Action message contains metadata information about a single action present in the external system.
      "description": "A String", # Brief Description of action
      "displayName": "A String", # Display Name of action to be shown on client side
      "inputJsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this actions's input schema
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        "jdbcType": "A String", # JDBC datatype of the field.
        "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          "a_key": # Object with schema name: JsonSchema
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
      "inputParameters": [ # List containing input parameter metadata.
        { # Input Parameter message contains metadata about the parameters required for executing an Action.
          "additionalDetails": { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
            "a_key": "", # Properties of the object.
          },
          "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.
          "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the parameter, applicable only if parameter is of type `STRUCT`
            "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
              "a_key": "", # Properties of the object.
            },
            "default": "", # The default value of the field or object described by this schema.
            "description": "A String", # A description of this schema.
            "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
              "",
            ],
            "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
            "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
            "jdbcType": "A String", # JDBC datatype of the field.
            "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
              "a_key": # Object with schema name: JsonSchema
            },
            "required": [ # Whether this property is required.
              "A String",
            ],
            "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
              "A String",
            ],
          },
          "name": "A String", # Name of the Parameter.
          "nullable": True or False, # Specifies whether a null value is allowed.
        },
      ],
      "name": "A String", # Name of the action.
      "resultJsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this actions's result schema
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        "jdbcType": "A String", # JDBC datatype of the field.
        "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          "a_key": # Object with schema name: JsonSchema
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
      "resultMetadata": [ # List containing the metadata of result fields.
        { # Result Metadata message contains metadata about the result returned after executing an Action.
          "dataType": "A String", # The data type of the metadata field
          "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 metadata field.
          "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT`
            "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
              "a_key": "", # Properties of the object.
            },
            "default": "", # The default value of the field or object described by this schema.
            "description": "A String", # A description of this schema.
            "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
              "",
            ],
            "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
            "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
            "jdbcType": "A String", # JDBC datatype of the field.
            "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
              "a_key": # Object with schema name: JsonSchema
            },
            "required": [ # Whether this property is required.
              "A String",
            ],
            "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
              "A String",
            ],
          },
          "name": "A String", # Name of the metadata field.
          "nullable": True or False, # Specifies whether a null value is allowed.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # Next page token if more actions available.
  "unsupportedActionNames": [ # List of actions which contain unsupported Datatypes. Check datatype.proto for more information.
    "A String",
  ],
}

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.