client.graph.index
Generated methods for the graph.index namespace.
Sync owner: WarmHubClient.graph.index. Async owner: AsyncWarmHubClient.graph.index.
Synchronous methods
Section titled “Synchronous methods”describe
Section titled “describe”describe(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> IndexedFieldsReportgraph.index.describe — query graph.index.describe.
pin(org_name: str, graph_name: str, shape: str, field_path: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> FieldIndexPinResultgraph.index.pin — mutate graph.index.pin.
unpin(org_name: str, graph_name: str, shape: str, field_path: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> FieldIndexPinResultgraph.index.unpin — mutate graph.index.unpin.
Asynchronous methods
Section titled “Asynchronous methods”describe
Section titled “describe”describe(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> IndexedFieldsReportgraph.index.describe — query graph.index.describe.
pin(org_name: str, graph_name: str, shape: str, field_path: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> FieldIndexPinResultgraph.index.pin — mutate graph.index.pin.
unpin(org_name: str, graph_name: str, shape: str, field_path: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> FieldIndexPinResultgraph.index.unpin — mutate graph.index.unpin.