| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a> . <a href="connectors_v1.projects.locations.connections.runtimeActionSchemas.html">runtimeActionSchemas</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, schemaAsString=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List schema of a runtime actions filtered by action name.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, schemaAsString=None, x__xgafv=None)</code> |
| <pre>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. |
| schemaAsString: boolean, Optional. Flag to indicate if schema should be returned as string or not |
| 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. |
| "description": "A String", # Output only. Brief Description of action |
| "displayName": "A String", # Output only. Display Name of action to be shown on client side |
| "inputJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's input metadata |
| "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": [ # 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. |
| "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's parameter |
| "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", |
| ], |
| }, |
| "nullable": True or False, # Specifies whether a null value is allowed. |
| "parameter": "A String", # Name of the Parameter. |
| }, |
| ], |
| "inputSchemaAsString": "A String", # Output only. Input schema as string. |
| "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata |
| "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": [ # Output only. List of result field metadata. |
| { # Metadata of result field. |
| "dataType": "A String", # The data type of the 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 field. |
| "field": "A String", # Name of the result field. |
| "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result |
| "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", |
| ], |
| }, |
| "nullable": True or False, # Specifies whether a null value is allowed. |
| }, |
| ], |
| "resultSchemaAsString": "A String", # Output only. Result schema as string. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
