close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets metadata of given entity type

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

Returns:
An object of the form:

{ # EntityType message contains metadata information about a single entity type present in the external system.
"fields": [ # List containing metadata information about each field of the entity type.
{ # Message contains EntityType's Field metadata.
"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.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the field, applicable only if field 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",
],
},
"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.
"name": "A String", # Name of the Field.
"nullable": True or False, # Specifies whether a null value is allowed.
"reference": { # Reference captures the association between two different entity types. Value links to the reference of another entity type.
"name": "A String", # Name of the reference field.
"type": "A String", # Name of reference entity type.
},
},
],
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's 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",
],
},
"name": "A String", # The name of the entity type.
"operations": [
"A String",
],
}

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

Lists metadata related to all entity types present in the external system.

Args:
parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} (required)
pageSize: integer, Number of entity types to return. Defaults to 25.
pageToken: string, Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.
view: string, Specifies which fields of the Entity Type are returned in the response.
Allowed values
ENTITY_TYPE_VIEW_UNSPECIFIED - VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.
ENTITY_TYPE_VIEW_BASIC - Return only entity type names.
ENTITY_TYPE_VIEW_FULL - Return entity types 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 EntityService.ListEntityTypes
"nextPageToken": "A String", # Next page token if more entity types available.
"types": [ # List of metadata related to all entity types.
{ # EntityType message contains metadata information about a single entity type present in the external system.
"fields": [ # List containing metadata information about each field of the entity type.
{ # Message contains EntityType's Field metadata.
"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.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the field, applicable only if field 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",
],
},
"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.
"name": "A String", # Name of the Field.
"nullable": True or False, # Specifies whether a null value is allowed.
"reference": { # Reference captures the association between two different entity types. Value links to the reference of another entity type.
"name": "A String", # Name of the reference field.
"type": "A String", # Name of reference entity type.
},
},
],
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's 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",
],
},
"name": "A String", # The name of the entity type.
"operations": [
"A String",
],
},
],
"unsupportedTypeNames": [ # List of entity type names 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.

Connectors API . projects . locations . connections . entityTypes

Instance Methods

Method Details