# Connectors API . projects . locations . connections . connectionSchemaMetadata

## Instance Methods

Close httplib2 connections.

Get action.

Get entity type.

List actions.

Retrieves the next page of results.

List entity types.

Retrieves the next page of results.

Refresh runtime schema of a connection.

### Method Details

`close()`

    Close httplib2 connections.

`getAction(name, actionId=None, x__xgafv=None)`

    Get action.

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`getEntityType(name, entityId=None, x__xgafv=None)`

    Get entity type.

    Args:
      name: string, Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
      entityId: string, Required. Id of the entity type.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`listActions(name, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)`

    List actions.

    Args:
      name: string, Required. Resource name format. projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
      filter: string, Required. Filter Wildcards are not supported in the filter currently.
      pageSize: integer, Page size. If unspecified, at most 50 actions will be returned.
      pageToken: string, Page token.
      view: string, Specifies which fields are returned in response. Defaults to BASIC view.
        Allowed values
          VIEW_UNSPECIFIED -
          BASIC -
      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 ListActions API
      "actions": [ # list of actions
        { # 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.
        },
      ],
      "nextPageToken": "A String", # token for next page
    }

`listActions_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.

`listEntityTypes(name, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)`

    List entity types.

    Args:
      name: string, Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
      filter: string, Required. Filter Wildcards are not supported in the filter currently.
      pageSize: integer, Page size. If unspecified, at most 50 entity types will be returned.
      pageToken: string, Page token.
      view: string, Specifies which fields are returned in response. Defaults to BASIC view.
        Allowed values
          VIEW_UNSPECIFIED -
          BASIC -
      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 ListEntityTypes API
      "entityTypes": [ # list of entity types
        { # 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
                "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.
              "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
            "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",
            ],
          },
          "operations": [ # List of operations supported by this entity
            "A String",
          ],
        },
      ],
      "nextPageToken": "A String", # token for next page
    }

`listEntityTypes_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.

`refresh(name, body=None, x__xgafv=None)`

    Refresh runtime schema of a connection.

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

    { # Request message for ConnectorsService.RefreshConnectionSchemaMetadata.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }