Close httplib2 connections.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List schema of a runtime entities filtered by entity name.
Retrieves the next page of results.
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
"$comment": "A String", # A comment on the schema.
"$defs": { # Definitions for the schema.
"a_key": # Object with schema name: JsonSchema
},
"$id": "A String", # The URI defining the core schema meta-schema.
"$ref": "A String", # A reference to another schema.
"$schema": "A String", # The URI defining the 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.
},
"additionalItems": # Object with schema name: JsonSchema # Schema for additional items.
"additionalProperties": # Object with schema name: JsonSchema # Schema for additional properties.
"allOf": [ # Schema that must be valid against all of the sub-schemas.
# Object with schema name: JsonSchema
],
"anyOf": [ # Schema that must be valid against at least one of the sub-schemas.
# Object with schema name: JsonSchema
],
"const": "", # Const value that the data must match.
"contains": # Object with schema name: JsonSchema # Schema that applies to at least one item in an array.
"contentEncoding": "A String", # Encoding of the content.
"contentMediaType": "A String", # Media type of the content.
"default": "", # The default value of the field or object described by this schema.
"definitions": { # Definitions for the schema.
"a_key": # Object with schema name: JsonSchema
},
"dependencies": { # Dependencies for the schema.
"a_key": "",
},
"description": "A String", # A description of this schema.
"else": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is invalid.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"examples": [ # Examples of the value.
"",
],
"exclusiveMaximum": "", # Whether the maximum number value is exclusive.
"exclusiveMinimum": "", # Whether the minimum number value is exclusive.
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"if": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid.
"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.
"maxItems": 42, # Maximum number of items in the array field.
"maxLength": 42, # Maximum length of the string field.
"maxProperties": 42, # Maximum number of properties.
"maximum": "", # Maximum value of the number field.
"minItems": 42, # Minimum number of items in the array field.
"minLength": 42, # Minimum length of the string field.
"minProperties": 42, # Minimum number of properties.
"minimum": "", # Minimum value of the number field.
"multipleOf": 3.14, # Number must be a multiple of this value.
"not": # Object with schema name: JsonSchema # Schema that must not be valid.
"oneOf": [ # Schema that must be valid against at least one of the sub-schemas.
# Object with schema name: JsonSchema
],
"pattern": "A String", # Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match.
"patternProperties": { # Pattern properties for the schema.
"a_key": # Object with schema name: JsonSchema
},
"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
},
"propertyNames": # Object with schema name: JsonSchema # Schema for property names.
"readOnly": True or False, # Whether the value is read-only.
"required": [ # Whether this property is required.
"A String",
],
"then": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid.
"title": "A String", # A title of the schema.
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
"uniqueItems": True or False, # Whether the items in the array field are unique.
"writeOnly": True or False, # Whether the value is write-only.
},
"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
"$comment": "A String", # A comment on the schema.
"$defs": { # Definitions for the schema.
"a_key": # Object with schema name: JsonSchema
},
"$id": "A String", # The URI defining the core schema meta-schema.
"$ref": "A String", # A reference to another schema.
"$schema": "A String", # The URI defining the 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.
},
"additionalItems": # Object with schema name: JsonSchema # Schema for additional items.
"additionalProperties": # Object with schema name: JsonSchema # Schema for additional properties.
"allOf": [ # Schema that must be valid against all of the sub-schemas.
# Object with schema name: JsonSchema
],
"anyOf": [ # Schema that must be valid against at least one of the sub-schemas.
# Object with schema name: JsonSchema
],
"const": "", # Const value that the data must match.
"contains": # Object with schema name: JsonSchema # Schema that applies to at least one item in an array.
"contentEncoding": "A String", # Encoding of the content.
"contentMediaType": "A String", # Media type of the content.
"default": "", # The default value of the field or object described by this schema.
"definitions": { # Definitions for the schema.
"a_key": # Object with schema name: JsonSchema
},
"dependencies": { # Dependencies for the schema.
"a_key": "",
},
"description": "A String", # A description of this schema.
"else": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is invalid.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"examples": [ # Examples of the value.
"",
],
"exclusiveMaximum": "", # Whether the maximum number value is exclusive.
"exclusiveMinimum": "", # Whether the minimum number value is exclusive.
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"if": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid.
"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.
"maxItems": 42, # Maximum number of items in the array field.
"maxLength": 42, # Maximum length of the string field.
"maxProperties": 42, # Maximum number of properties.
"maximum": "", # Maximum value of the number field.
"minItems": 42, # Minimum number of items in the array field.
"minLength": 42, # Minimum length of the string field.
"minProperties": 42, # Minimum number of properties.
"minimum": "", # Minimum value of the number field.
"multipleOf": 3.14, # Number must be a multiple of this value.
"not": # Object with schema name: JsonSchema # Schema that must not be valid.
"oneOf": [ # Schema that must be valid against at least one of the sub-schemas.
# Object with schema name: JsonSchema
],
"pattern": "A String", # Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match.
"patternProperties": { # Pattern properties for the schema.
"a_key": # Object with schema name: JsonSchema
},
"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
},
"propertyNames": # Object with schema name: JsonSchema # Schema for property names.
"readOnly": True or False, # Whether the value is read-only.
"required": [ # Whether this property is required.
"A String",
],
"then": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid.
"title": "A String", # A title of the schema.
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
"uniqueItems": True or False, # Whether the items in the array field are unique.
"writeOnly": True or False, # Whether the value is write-only.
},
"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.