Connectors API . projects . locations . connections . runtimeEntitySchemas

close()

Close httplib2 connections.

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

List schema of a runtime entities filtered by entity name.

Args:
  parent: string, Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection} (required)
  filter: string, Required. Filter Format: entity="{entityId}" Only entity field is supported with literal equality operator. Accepted filter example: entity="Order" 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.ListRuntimeEntitySchemas.
  "nextPageToken": "A String", # Next page token.
  "runtimeEntitySchemas": [ # Runtime entity schemas.
    { # Schema of a runtime entity.
      "entity": "A String", # Output only. Name of the entity.
      "fields": [ # Output only. List of fields in the entity.
        { # Metadata of an entity field.
          "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 Field.
          "defaultValue": "", # The following field specifies the default value of the Field 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 Field.
          "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema
            "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",
            ],
          },
          "key": True or False, # The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
          "nullable": True or False, # Specifies whether a null value is allowed.
          "readonly": True or False, # Specifies if the Field is readonly.
        },
      ],
      "jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata
        "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",
        ],
      },
      "operations": [ # List of operations supported by this entity
        "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.