snowflake.core.api_integration.ApiIntegration¶

class snowflake.core.api_integration.ApiIntegration(*, name: Annotated[str, Strict(strict=True)], api_hook: ApiHook, api_allowed_prefixes: List[Annotated[str, Strict(strict=True)]], api_blocked_prefixes: List[Annotated[str, Strict(strict=True)]] | None = None, enabled: Annotated[bool, Strict(strict=True)], comment: Annotated[str, Strict(strict=True)] | None = None, created_on: datetime | None = None)¶

Bases: BaseModel

A model object representing the ApiIntegration resource.

Constructs an object of type ApiIntegration with the provided properties.

Parameters:

  • name (str) – Name of the API integration.

  • api_hook (ApiHook)

  • api_allowed_prefixes (List[str]) – A comma-separated list of endpoints and resources that Snowflake can access.

  • enabled (bool) – Whether the API integration is enabled.

  • api_blocked_prefixes (List[str], optional) – A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake.

  • comment (str, optional) – Comment for the API integration.

  • created_on (datetime, optional) – Date and time when the API integration was created.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → ApiIntegration¶

Create an instance of ApiIntegration from a dict.

classmethod from_json(json_str: str) → ApiIntegration¶

Create an instance of ApiIntegration from a JSON string.

to_dict(hide_readonly_properties: bool = False) → dict[str, Any]¶

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → dict[str, Any]¶

Return the dictionary representation of the model without readonly properties.

to_json() → str¶

Returns the JSON representation of the model using alias.

to_str() → str¶

Returns the string representation of the model using alias.

Language: English