openapi

package module
v0.0.0-...-90002b2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 20, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

Go API client for openapi

Authorization

The Looker API uses Looker API3 credentials for authorization and access control. Looker admins can create API3 credentials on Looker's Admin/Users page. Pass API3 credentials to the _/login endpoint to obtain a temporary access_token. Include that access_token in the Authorization header of Looker API requests. For details, see Looker API Authorization

Client SDKs

The Looker API is a RESTful system that should be usable by any programming language capable of making HTTPS requests. Client SDKs for a variety of programming languages can be generated from the Looker API's Swagger JSON metadata to streamline use of the Looker API in your applications. A client SDK for Ruby is available as an example. For more information, see Looker API Client SDKs

Try It Out!

The 'api-docs' page served by the Looker instance includes 'Try It Out!' buttons for each API method. After logging in with API3 credentials, you can use the "Try It Out!" buttons to call the API directly from the documentation page to interactively explore API features and responses.

Note! With great power comes great responsibility: The "Try It Out!" button makes API calls to your live Looker instance. Be especially careful with destructive API operations such as delete_user or similar. There is no "undo" for API operations.

Versioning

Future releases of Looker will expand this API release-by-release to securely expose more and more of the core power of Looker to API client applications. API endpoints marked as "beta" may receive breaking changes without warning (but we will try to avoid doing that). Stable (non-beta) API endpoints should not receive breaking changes in future releases. For more information, see Looker API Versioning

In This Release

The following are a few examples of noteworthy items that have changed between API 3.0 and API 3.1. For more comprehensive coverage of API changes, please see the release notes for your Looker release.

Examples of new things added in API 3.1 (compared to API 3.0):
Deprecated in API 3.0

The following functions and properties have been deprecated in API 3.0. They continue to exist and work in API 3.0 for the next several Looker releases but they have not been carried forward to API 3.1:

  • Dashboard Prefetch functions
  • User access_filter functions
  • User API 1.0 credentials functions
  • Space.is_root and Space.is_user_root properties. Use Space.is_shared_root and Space.is_users_root instead.
Semantic changes in API 3.1:

If you have application code which relies on the old behavior of the APIs above, you may continue using the API 3.0 functions in this Looker release. We strongly suggest you update your code to use API 3.1 analogs as soon as possible.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 3.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://looker.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://mattermost.looker.com:19999/api/3.1

Class Method HTTP request Description
ApiAuthApi Login Post /login Login
ApiAuthApi LoginUser Post /login/{user_id} Login user
ApiAuthApi Logout Delete /logout Logout
AuthApi AllUserLoginLockouts Get /user_login_lockouts Get All User Login Lockouts
AuthApi CreateOidcTestConfig Post /oidc_test_configs Create OIDC Test Configuration
AuthApi CreateSamlTestConfig Post /saml_test_configs Create SAML Test Configuration
AuthApi CreateSsoEmbedUrl Post /embed/sso_url Create SSO Embed Url
AuthApi DeleteOidcTestConfig Delete /oidc_test_configs/{test_slug} Delete OIDC Test Configuration
AuthApi DeleteSamlTestConfig Delete /saml_test_configs/{test_slug} Delete SAML Test Configuration
AuthApi DeleteUserLoginLockout Delete /user_login_lockout/{key} Delete User Login Lockout
AuthApi FetchAndParseSamlIdpMetadata Post /fetch_and_parse_saml_idp_metadata Parse SAML IdP Url
AuthApi ForcePasswordResetAtNextLoginForAllUsers Put /password_config/force_password_reset_at_next_login_for_all_users Force password reset
AuthApi LdapConfig Get /ldap_config Get LDAP Configuration
AuthApi OidcConfig Get /oidc_config Get OIDC Configuration
AuthApi OidcTestConfig Get /oidc_test_configs/{test_slug} Get OIDC Test Configuration
AuthApi ParseSamlIdpMetadata Post /parse_saml_idp_metadata Parse SAML IdP XML
AuthApi PasswordConfig Get /password_config Get Password Config
AuthApi SamlConfig Get /saml_config Get SAML Configuration
AuthApi SamlTestConfig Get /saml_test_configs/{test_slug} Get SAML Test Configuration
AuthApi SearchUserLoginLockouts Get /user_login_lockouts/search Search User Login Lockouts
AuthApi SessionConfig Get /session_config Get Session Config
AuthApi TestLdapConfigAuth Put /ldap_config/test_auth Test LDAP Auth
AuthApi TestLdapConfigConnection Put /ldap_config/test_connection Test LDAP Connection
AuthApi TestLdapConfigUserAuth Put /ldap_config/test_user_auth Test LDAP User Auth
AuthApi TestLdapConfigUserInfo Put /ldap_config/test_user_info Test LDAP User Info
AuthApi UpdateLdapConfig Patch /ldap_config Update LDAP Configuration
AuthApi UpdateOidcConfig Patch /oidc_config Update OIDC Configuration
AuthApi UpdatePasswordConfig Patch /password_config Update Password Config
AuthApi UpdateSamlConfig Patch /saml_config Update SAML Configuration
AuthApi UpdateSessionConfig Patch /session_config Update Session Config
ColorCollectionApi AllColorCollections Get /color_collections Get all Color Collections
ColorCollectionApi ColorCollection Get /color_collections/{collection_id} Get Color Collection by ID
ColorCollectionApi ColorCollectionsCustom Get /color_collections/custom Get all Custom Color Collections
ColorCollectionApi ColorCollectionsStandard Get /color_collections/standard Get all Standard Color Collections
ColorCollectionApi CreateColorCollection Post /color_collections Create ColorCollection
ColorCollectionApi DefaultColorCollection Get /color_collections/default Get Default Color Collection
ColorCollectionApi DeleteColorCollection Delete /color_collections/{collection_id} Delete ColorCollection
ColorCollectionApi SetDefaultColorCollection Put /color_collections/default Set Default Color Collection
ColorCollectionApi UpdateColorCollection Patch /color_collections/{collection_id} Update Custom Color collection
ConfigApi AllLegacyFeatures Get /legacy_features Get All Legacy Features
ConfigApi AllLocales Get /locales Get All Locales
ConfigApi AllTimezones Get /timezones Get All Timezones
ConfigApi BackupConfiguration Get /backup_configuration Get Backup Configuration
ConfigApi CustomWelcomeEmail Get /custom_welcome_email Get Custom Welcome Email
ConfigApi InternalHelpResources Get /internal_help_resources_enabled Get Internal Help Resources
ConfigApi InternalHelpResourcesContent Get /internal_help_resources_content Get Internal Help Resources Content
ConfigApi LegacyFeature Get /legacy_features/{legacy_feature_id} Get Legacy Feature
ConfigApi UpdateBackupConfiguration Patch /backup_configuration Update Backup Configuration
ConfigApi UpdateCustomWelcomeEmail Patch /custom_welcome_email Update Custom Welcome Email Content
ConfigApi UpdateCustomWelcomeEmailTest Put /custom_welcome_email_test Send a test welcome email to the currently logged in user with the supplied content
ConfigApi UpdateInternalHelpResources Patch /internal_help_resources Update internal help resources configuration
ConfigApi UpdateInternalHelpResourcesContent Patch /internal_help_resources_content Update internal help resources content
ConfigApi UpdateLegacyFeature Patch /legacy_features/{legacy_feature_id} Update Legacy Feature
ConfigApi UpdateWhitelabelConfiguration Put /whitelabel_configuration Update Whitelabel configuration
ConfigApi Versions Get /versions Get ApiVersion
ConfigApi WhitelabelConfiguration Get /whitelabel_configuration Get Whitelabel configuration
ConnectionApi AllConnections Get /connections Get All Connections
ConnectionApi AllDialectInfos Get /dialect_info Get All Dialect Infos
ConnectionApi Connection Get /connections/{connection_name} Get Connection
ConnectionApi CreateConnection Post /connections Create Connection
ConnectionApi DeleteConnection Delete /connections/{connection_name} Delete Connection
ConnectionApi DeleteConnectionOverride Delete /connections/{connection_name}/connection_override/{override_context} Delete Connection Override
ConnectionApi TestConnection Put /connections/{connection_name}/test Test Connection
ConnectionApi TestConnectionConfig Put /connections/test Test Connection Configuration
ConnectionApi UpdateConnection Patch /connections/{connection_name} Update Connection
ContentApi AllContentMetadataAccesses Get /content_metadata_access Get All Content Metadata Accesses
ContentApi AllContentMetadatas Get /content_metadata Get All Content Metadatas
ContentApi ContentFavorite Get /content_favorite/{content_favorite_id} Get Favorite Content
ContentApi ContentMetadata Get /content_metadata/{content_metadata_id} Get Content Metadata
ContentApi ContentValidation Get /content_validation Validate Content
ContentApi CreateContentFavorite Post /content_favorite Create Favorite Content
ContentApi CreateContentMetadataAccess Post /content_metadata_access Create Content Metadata Access
ContentApi DeleteContentFavorite Delete /content_favorite/{content_favorite_id} Delete Favorite Content
ContentApi DeleteContentMetadataAccess Delete /content_metadata_access/{content_metadata_access_id} Delete Content Metadata Access
ContentApi SearchContentFavorites Get /content_favorite/search Search Favorite Contents
ContentApi SearchContentViews Get /content_view/search Search Content Views
ContentApi UpdateContentMetadata Patch /content_metadata/{content_metadata_id} Update Content Metadata
ContentApi UpdateContentMetadataAccess Put /content_metadata_access/{content_metadata_access_id} Update Content Metadata Access
DashboardApi AllDashboards Get /dashboards Get All Dashboards
DashboardApi CreateDashboard Post /dashboards Create Dashboard
DashboardApi CreateDashboardElement Post /dashboard_elements Create DashboardElement
DashboardApi CreateDashboardFilter Post /dashboard_filters Create Dashboard Filter
DashboardApi CreateDashboardLayout Post /dashboard_layouts Create DashboardLayout
DashboardApi Dashboard Get /dashboards/{dashboard_id} Get Dashboard
DashboardApi DashboardDashboardElements Get /dashboards/{dashboard_id}/dashboard_elements Get All DashboardElements
DashboardApi DashboardDashboardFilters Get /dashboards/{dashboard_id}/dashboard_filters Get All Dashboard Filters
DashboardApi DashboardDashboardLayouts Get /dashboards/{dashboard_id}/dashboard_layouts Get All DashboardLayouts
DashboardApi DashboardElement Get /dashboard_elements/{dashboard_element_id} Get DashboardElement
DashboardApi DashboardFilter Get /dashboard_filters/{dashboard_filter_id} Get Dashboard Filter
DashboardApi DashboardLayout Get /dashboard_layouts/{dashboard_layout_id} Get DashboardLayout
DashboardApi DashboardLayoutComponent Get /dashboard_layout_components/{dashboard_layout_component_id} Get DashboardLayoutComponent
DashboardApi DashboardLayoutDashboardLayoutComponents Get /dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components Get All DashboardLayoutComponents
DashboardApi DashboardLookml Get /dashboards/lookml/{dashboard_id} Get lookml of a UDD
DashboardApi DeleteDashboard Delete /dashboards/{dashboard_id} Delete Dashboard
DashboardApi DeleteDashboardElement Delete /dashboard_elements/{dashboard_element_id} Delete DashboardElement
DashboardApi DeleteDashboardFilter Delete /dashboard_filters/{dashboard_filter_id} Delete Dashboard Filter
DashboardApi DeleteDashboardLayout Delete /dashboard_layouts/{dashboard_layout_id} Delete DashboardLayout
DashboardApi ImportLookmlDashboard Post /dashboards/{lookml_dashboard_id}/import/{space_id} Import LookML Dashboard
DashboardApi SearchDashboardElements Get /dashboard_elements/search Search Dashboard Elements
DashboardApi SearchDashboards Get /dashboards/search Search Dashboards
DashboardApi SyncLookmlDashboard Patch /dashboards/{lookml_dashboard_id}/sync Sync LookML Dashboard
DashboardApi UpdateDashboard Patch /dashboards/{dashboard_id} Update Dashboard
DashboardApi UpdateDashboardElement Patch /dashboard_elements/{dashboard_element_id} Update DashboardElement
DashboardApi UpdateDashboardFilter Patch /dashboard_filters/{dashboard_filter_id} Update Dashboard Filter
DashboardApi UpdateDashboardLayout Patch /dashboard_layouts/{dashboard_layout_id} Update DashboardLayout
DashboardApi UpdateDashboardLayoutComponent Patch /dashboard_layout_components/{dashboard_layout_component_id} Update DashboardLayoutComponent
DataActionApi FetchRemoteDataActionForm Post /data_actions/form Fetch Remote Data Action Form
DataActionApi PerformDataAction Post /data_actions Send a Data Action
DatagroupApi AllDatagroups Get /datagroups Get All Datagroups
DatagroupApi Datagroup Get /datagroups/{datagroup_id} Get Datagroup
DatagroupApi UpdateDatagroup Patch /datagroups/{datagroup_id} Update Datagroup
FolderApi AllFolders Get /folders Get All Folders
FolderApi CreateFolder Post /folders Create Folder
FolderApi DeleteFolder Delete /folders/{folder_id} Delete Folder
FolderApi Folder Get /folders/{folder_id} Get Folder
FolderApi FolderAncestors Get /folders/{folder_id}/ancestors Get Folder Ancestors
FolderApi FolderChildren Get /folders/{folder_id}/children Get Folder Children
FolderApi FolderChildrenSearch Get /folders/{folder_id}/children/search Search Folder Children
FolderApi FolderDashboards Get /folders/{folder_id}/dashboards Get Folder Dashboards
FolderApi FolderLooks Get /folders/{folder_id}/looks Get Folder Looks
FolderApi FolderParent Get /folders/{folder_id}/parent Get Folder Parent
FolderApi SearchFolders Get /folders/search Search Folders
FolderApi UpdateFolder Patch /folders/{folder_id} Update Folder
GroupApi AddGroupGroup Post /groups/{group_id}/groups Add a Group to Group
GroupApi AddGroupUser Post /groups/{group_id}/users Add a User to Group
GroupApi AllGroupGroups Get /groups/{group_id}/groups Get All Groups in Group
GroupApi AllGroupUsers Get /groups/{group_id}/users Get All Users in Group
GroupApi AllGroups Get /groups Get All Groups
GroupApi CreateGroup Post /groups Create Group
GroupApi DeleteGroup Delete /groups/{group_id} Delete Group
GroupApi DeleteGroupFromGroup Delete /groups/{group_id}/groups/{deleting_group_id} Deletes a Group from Group
GroupApi DeleteGroupUser Delete /groups/{group_id}/users/{user_id} Remove a User from Group
GroupApi DeleteUserAttributeGroupValue Delete /groups/{group_id}/attribute_values/{user_attribute_id} Delete User Attribute Group Value
GroupApi Group Get /groups/{group_id} Get Group
GroupApi SearchGroups Get /groups/search Search Groups
GroupApi UpdateGroup Patch /groups/{group_id} Update Group
GroupApi UpdateUserAttributeGroupValue Patch /groups/{group_id}/attribute_values/{user_attribute_id} Set User Attribute Group Value
HomepageApi AllHomepageItems Get /homepage_items Get All Homepage Items
HomepageApi AllHomepageSections Get /homepage_sections Get All Homepage sections
HomepageApi AllHomepages Get /homepages Get All Homepages
HomepageApi CreateHomepage Post /homepages Create Homepage
HomepageApi CreateHomepageItem Post /homepage_items Create Homepage Item
HomepageApi CreateHomepageSection Post /homepage_sections Create Homepage section
HomepageApi DeleteHomepage Delete /homepages/{homepage_id} Delete Homepage
HomepageApi DeleteHomepageItem Delete /homepage_items/{homepage_item_id} Delete Homepage Item
HomepageApi DeleteHomepageSection Delete /homepage_sections/{homepage_section_id} Delete Homepage section
HomepageApi Homepage Get /homepages/{homepage_id} Get Homepage
HomepageApi HomepageItem Get /homepage_items/{homepage_item_id} Get Homepage Item
HomepageApi HomepageSection Get /homepage_sections/{homepage_section_id} Get Homepage section
HomepageApi SearchHomepages Get /homepages/search Search Homepages
HomepageApi UpdateHomepage Patch /homepages/{homepage_id} Update Homepage
HomepageApi UpdateHomepageItem Patch /homepage_items/{homepage_item_id} Update Homepage Item
HomepageApi UpdateHomepageSection Patch /homepage_sections/{homepage_section_id} Update Homepage section
IntegrationApi AcceptIntegrationHubLegalAgreement Post /integration_hubs/{integration_hub_id}/accept_legal_agreement Accept Integration Hub Legal Agreement
IntegrationApi AllIntegrationHubs Get /integration_hubs Get All Integration Hubs
IntegrationApi AllIntegrations Get /integrations Get All Integrations
IntegrationApi CreateIntegrationHub Post /integration_hubs Create Integration Hub
IntegrationApi DeleteIntegrationHub Delete /integration_hubs/{integration_hub_id} Delete Integration Hub
IntegrationApi FetchIntegrationForm Post /integrations/{integration_id}/form Fetch Remote Integration Form
IntegrationApi Integration Get /integrations/{integration_id} Get Integration
IntegrationApi IntegrationHub Get /integration_hubs/{integration_hub_id} Get Integration Hub
IntegrationApi TestIntegration Post /integrations/{integration_id}/test Test integration
IntegrationApi UpdateIntegration Patch /integrations/{integration_id} Update Integration
IntegrationApi UpdateIntegrationHub Patch /integration_hubs/{integration_hub_id} Update Integration Hub
LookApi AllLooks Get /looks Get All Looks
LookApi CreateLook Post /looks Create Look
LookApi DeleteLook Delete /looks/{look_id} Delete Look
LookApi Look Get /looks/{look_id} Get Look
LookApi RunLook Get /looks/{look_id}/run/{result_format} Run Look
LookApi SearchLooks Get /looks/search Search Looks
LookApi UpdateLook Patch /looks/{look_id} Update Look
LookmlModelApi AllLookmlModels Get /lookml_models Get All LookML Models
LookmlModelApi CreateLookmlModel Post /lookml_models Create LookML Model
LookmlModelApi DeleteLookmlModel Delete /lookml_models/{lookml_model_name} Delete LookML Model
LookmlModelApi LookmlModel Get /lookml_models/{lookml_model_name} Get LookML Model
LookmlModelApi LookmlModelExplore Get /lookml_models/{lookml_model_name}/explores/{explore_name} Get LookML Model Explore
LookmlModelApi UpdateLookmlModel Patch /lookml_models/{lookml_model_name} Update LookML Model
ProjectApi AllGitBranches Get /projects/{project_id}/git_branches Get All Git Branches
ProjectApi AllGitConnectionTests Get /projects/{project_id}/git_connection_tests Get All Git Connection Tests
ProjectApi AllLookmlTests Get /projects/{project_id}/lookml_tests Get All LookML Tests
ProjectApi AllProjectFiles Get /projects/{project_id}/files Get All Project Files
ProjectApi AllProjects Get /projects Get All Projects
ProjectApi CreateGitBranch Post /projects/{project_id}/git_branch Checkout New Git Branch
ProjectApi CreateGitDeployKey Post /projects/{project_id}/git/deploy_key Create Deploy Key
ProjectApi CreateProject Post /projects Create Project
ProjectApi DeleteGitBranch Delete /projects/{project_id}/git_branch/{branch_name} Delete a Git Branch
ProjectApi DeleteRepositoryCredential Delete /projects/{root_project_id}/credential/{credential_id} Delete Repository Credential
ProjectApi DeployToProduction Post /projects/{project_id}/deploy_to_production Deploy To Production
ProjectApi FindGitBranch Get /projects/{project_id}/git_branch/{branch_name} Find a Git Branch
ProjectApi GetAllRepositoryCredentials Get /projects/{root_project_id}/credentials Get All Repository Credentials
ProjectApi GitBranch Get /projects/{project_id}/git_branch Get Active Git Branch
ProjectApi GitDeployKey Get /projects/{project_id}/git/deploy_key Git Deploy Key
ProjectApi Manifest Get /projects/{project_id}/manifest Get Manifest
ProjectApi Project Get /projects/{project_id} Get Project
ProjectApi ProjectFile Get /projects/{project_id}/files/file Get Project File
ProjectApi ProjectValidationResults Get /projects/{project_id}/validate Cached Project Validation Results
ProjectApi ProjectWorkspace Get /projects/{project_id}/current_workspace Get Project Workspace
ProjectApi ResetProjectToProduction Post /projects/{project_id}/reset_to_production Reset To Production
ProjectApi ResetProjectToRemote Post /projects/{project_id}/reset_to_remote Reset To Remote
ProjectApi RunGitConnectionTest Get /projects/{project_id}/git_connection_tests/{test_id} Run Git Connection Test
ProjectApi RunLookmlTest Get /projects/{project_id}/lookml_tests/run Run LookML Test
ProjectApi UpdateGitBranch Put /projects/{project_id}/git_branch Update Project Git Branch
ProjectApi UpdateProject Patch /projects/{project_id} Update Project
ProjectApi UpdateRepositoryCredential Put /projects/{root_project_id}/credential/{credential_id} Create Repository Credential
ProjectApi ValidateProject Post /projects/{project_id}/validate Validate Project
QueryApi AllRunningQueries Get /running_queries Get All Running Queries
QueryApi CreateMergeQuery Post /merge_queries Create Merge Query
QueryApi CreateQuery Post /queries Create Query
QueryApi CreateQueryTask Post /query_tasks Run Query Async
QueryApi CreateSqlQuery Post /sql_queries Create SQL Runner Query
QueryApi KillQuery Delete /running_queries/{query_task_id} Kill Running Query
QueryApi MergeQuery Get /merge_queries/{merge_query_id} Get Merge Query
QueryApi Query Get /queries/{query_id} Get Query
QueryApi QueryForSlug Get /queries/slug/{slug} Get Query for Slug
QueryApi QueryTask Get /query_tasks/{query_task_id} Get Async Query Info
QueryApi QueryTaskMultiResults Get /query_tasks/multi_results Get Multiple Async Query Results
QueryApi QueryTaskResults Get /query_tasks/{query_task_id}/results Get Async Query Results
QueryApi RunInlineQuery Post /queries/run/{result_format} Run Inline Query
QueryApi RunQuery Get /queries/{query_id}/run/{result_format} Run Query
QueryApi RunSqlQuery Post /sql_queries/{slug}/run/{result_format} Run SQL Runner Query
QueryApi RunUrlEncodedQuery Get /queries/models/{model_name}/views/{view_name}/run/{result_format} Run Url Encoded Query
QueryApi SqlQuery Get /sql_queries/{slug} Get SQL Runner Query
RenderTaskApi CreateDashboardRenderTask Post /render_tasks/dashboards/{dashboard_id}/{result_format} Create Dashboard Render Task
RenderTaskApi CreateLookRenderTask Post /render_tasks/looks/{look_id}/{result_format} Create Look Render Task
RenderTaskApi CreateLookmlDashboardRenderTask Post /render_tasks/lookml_dashboards/{dashboard_id}/{result_format} Create Lookml Dashboard Render Task
RenderTaskApi CreateQueryRenderTask Post /render_tasks/queries/{query_id}/{result_format} Create Query Render Task
RenderTaskApi RenderTask Get /render_tasks/{render_task_id} Get Render Task
RenderTaskApi RenderTaskResults Get /render_tasks/{render_task_id}/results Render Task Results
RoleApi AllModelSets Get /model_sets Get All Model Sets
RoleApi AllPermissionSets Get /permission_sets Get All Permission Sets
RoleApi AllPermissions Get /permissions Get All Permissions
RoleApi AllRoles Get /roles Get All Roles
RoleApi CreateModelSet Post /model_sets Create Model Set
RoleApi CreatePermissionSet Post /permission_sets Create Permission Set
RoleApi CreateRole Post /roles Create Role
RoleApi DeleteModelSet Delete /model_sets/{model_set_id} Delete Model Set
RoleApi DeletePermissionSet Delete /permission_sets/{permission_set_id} Delete Permission Set
RoleApi DeleteRole Delete /roles/{role_id} Delete Role
RoleApi ModelSet Get /model_sets/{model_set_id} Get Model Set
RoleApi PermissionSet Get /permission_sets/{permission_set_id} Get Permission Set
RoleApi Role Get /roles/{role_id} Get Role
RoleApi RoleGroups Get /roles/{role_id}/groups Get Role Groups
RoleApi RoleUsers Get /roles/{role_id}/users Get Role Users
RoleApi SearchModelSets Get /model_sets/search Search Model Sets
RoleApi SearchPermissionSets Get /permission_sets/search Search Permission Sets
RoleApi SearchRoles Get /roles/search Search Roles
RoleApi SetRoleGroups Put /roles/{role_id}/groups Update Role Groups
RoleApi SetRoleUsers Put /roles/{role_id}/users Update Role Users
RoleApi UpdateModelSet Patch /model_sets/{model_set_id} Update Model Set
RoleApi UpdatePermissionSet Patch /permission_sets/{permission_set_id} Update Permission Set
RoleApi UpdateRole Patch /roles/{role_id} Update Role
ScheduledPlanApi AllScheduledPlans Get /scheduled_plans Get All Scheduled Plans
ScheduledPlanApi CreateScheduledPlan Post /scheduled_plans Create Scheduled Plan
ScheduledPlanApi DeleteScheduledPlan Delete /scheduled_plans/{scheduled_plan_id} Delete Scheduled Plan
ScheduledPlanApi ScheduledPlan Get /scheduled_plans/{scheduled_plan_id} Get Scheduled Plan
ScheduledPlanApi ScheduledPlanRunOnce Post /scheduled_plans/run_once Run Scheduled Plan Once
ScheduledPlanApi ScheduledPlanRunOnceById Post /scheduled_plans/{scheduled_plan_id}/run_once Run Scheduled Plan Once by Id
ScheduledPlanApi ScheduledPlansForDashboard Get /scheduled_plans/dashboard/{dashboard_id} Scheduled Plans for Dashboard
ScheduledPlanApi ScheduledPlansForLook Get /scheduled_plans/look/{look_id} Scheduled Plans for Look
ScheduledPlanApi ScheduledPlansForLookmlDashboard Get /scheduled_plans/lookml_dashboard/{lookml_dashboard_id} Scheduled Plans for LookML Dashboard
ScheduledPlanApi ScheduledPlansForSpace Get /scheduled_plans/space/{space_id} Scheduled Plans for Space
ScheduledPlanApi UpdateScheduledPlan Patch /scheduled_plans/{scheduled_plan_id} Update Scheduled Plan
SessionApi Session Get /session Get Session
SessionApi UpdateSession Patch /session Update Session
SpaceApi AllSpaces Get /spaces Get All Spaces
SpaceApi CreateSpace Post /spaces Create Space
SpaceApi DeleteSpace Delete /spaces/{space_id} Delete Space
SpaceApi SearchSpaces Get /spaces/search Search Spaces
SpaceApi Space Get /spaces/{space_id} Get Space
SpaceApi SpaceAncestors Get /spaces/{space_id}/ancestors Get Space Ancestors
SpaceApi SpaceChildren Get /spaces/{space_id}/children Get Space Children
SpaceApi SpaceChildrenSearch Get /spaces/{space_id}/children/search Search Space Children
SpaceApi SpaceDashboards Get /spaces/{space_id}/dashboards Get Space Dashboards
SpaceApi SpaceLooks Get /spaces/{space_id}/looks Get Space Looks
SpaceApi SpaceParent Get /spaces/{space_id}/parent Get Space Parent
SpaceApi UpdateSpace Patch /spaces/{space_id} Update Space
ThemeApi ActiveThemes Get /themes/active Get Active Themes
ThemeApi AllThemes Get /themes Get All Themes
ThemeApi CreateTheme Post /themes Create Theme
ThemeApi DefaultTheme Get /themes/default Get Default Theme
ThemeApi DeleteTheme Delete /themes/{theme_id} Delete Theme
ThemeApi SearchThemes Get /themes/search Search Themes
ThemeApi SetDefaultTheme Put /themes/default Set Default Theme
ThemeApi Theme Get /themes/{theme_id} Get Theme
ThemeApi ThemeOrDefault Get /themes/theme_or_default Get Theme or Default
ThemeApi UpdateTheme Patch /themes/{theme_id} Update Theme
ThemeApi ValidateTheme Post /themes/validate Validate Theme
UserApi AllUserCredentialsApi3s Get /users/{user_id}/credentials_api3 Get All API 3 Credentials
UserApi AllUserCredentialsEmbeds Get /users/{user_id}/credentials_embed Get All Embedding Credentials
UserApi AllUserSessions Get /users/{user_id}/sessions Get All Web Login Sessions
UserApi AllUsers Get /users Get All Users
UserApi CreateUser Post /users Create User
UserApi CreateUserCredentialsApi3 Post /users/{user_id}/credentials_api3 Create API 3 Credential
UserApi CreateUserCredentialsEmail Post /users/{user_id}/credentials_email Create Email/Password Credential
UserApi CreateUserCredentialsEmailPasswordReset Post /users/{user_id}/credentials_email/password_reset Create Password Reset Token
UserApi CreateUserCredentialsTotp Post /users/{user_id}/credentials_totp Create Two-Factor Credential
UserApi DeleteUser Delete /users/{user_id} Delete User
UserApi DeleteUserAttributeUserValue Delete /users/{user_id}/attribute_values/{user_attribute_id} Delete User Attribute User Value
UserApi DeleteUserCredentialsApi3 Delete /users/{user_id}/credentials_api3/{credentials_api3_id} Delete API 3 Credential
UserApi DeleteUserCredentialsEmail Delete /users/{user_id}/credentials_email Delete Email/Password Credential
UserApi DeleteUserCredentialsEmbed Delete /users/{user_id}/credentials_embed/{credentials_embed_id} Delete Embedding Credential
UserApi DeleteUserCredentialsGoogle Delete /users/{user_id}/credentials_google Delete Google Auth Credential
UserApi DeleteUserCredentialsLdap Delete /users/{user_id}/credentials_ldap Delete LDAP Credential
UserApi DeleteUserCredentialsLookerOpenid Delete /users/{user_id}/credentials_looker_openid Delete Looker OpenId Credential
UserApi DeleteUserCredentialsOidc Delete /users/{user_id}/credentials_oidc Delete OIDC Auth Credential
UserApi DeleteUserCredentialsSaml Delete /users/{user_id}/credentials_saml Delete Saml Auth Credential
UserApi DeleteUserCredentialsTotp Delete /users/{user_id}/credentials_totp Delete Two-Factor Credential
UserApi DeleteUserSession Delete /users/{user_id}/sessions/{session_id} Delete Web Login Session
UserApi Me Get /user Get Current User
UserApi SearchUsers Get /users/search Search Users
UserApi SearchUsersNames Get /users/search/names/{pattern} Search User Names
UserApi SetUserAttributeUserValue Patch /users/{user_id}/attribute_values/{user_attribute_id} Set User Attribute User Value
UserApi SetUserRoles Put /users/{user_id}/roles Set User Roles
UserApi UpdateUser Patch /users/{user_id} Update User
UserApi UpdateUserCredentialsEmail Patch /users/{user_id}/credentials_email Update Email/Password Credential
UserApi User Get /users/{user_id} Get User by Id
UserApi UserAttributeUserValues Get /users/{user_id}/attribute_values Get User Attribute Values
UserApi UserCredentialsApi3 Get /users/{user_id}/credentials_api3/{credentials_api3_id} Get API 3 Credential
UserApi UserCredentialsEmail Get /users/{user_id}/credentials_email Get Email/Password Credential
UserApi UserCredentialsEmbed Get /users/{user_id}/credentials_embed/{credentials_embed_id} Get Embedding Credential
UserApi UserCredentialsGoogle Get /users/{user_id}/credentials_google Get Google Auth Credential
UserApi UserCredentialsLdap Get /users/{user_id}/credentials_ldap Get LDAP Credential
UserApi UserCredentialsLookerOpenid Get /users/{user_id}/credentials_looker_openid Get Looker OpenId Credential
UserApi UserCredentialsOidc Get /users/{user_id}/credentials_oidc Get OIDC Auth Credential
UserApi UserCredentialsSaml Get /users/{user_id}/credentials_saml Get Saml Auth Credential
UserApi UserCredentialsTotp Get /users/{user_id}/credentials_totp Get Two-Factor Credential
UserApi UserForCredential Get /users/credential/{credential_type}/{credential_id} Get User by Credential Id
UserApi UserRoles Get /users/{user_id}/roles Get User Roles
UserApi UserSession Get /users/{user_id}/sessions/{session_id} Get Web Login Session
UserAttributeApi AllUserAttributeGroupValues Get /user_attributes/{user_attribute_id}/group_values Get User Attribute Group Values
UserAttributeApi AllUserAttributes Get /user_attributes Get All User Attributes
UserAttributeApi CreateUserAttribute Post /user_attributes Create User Attribute
UserAttributeApi DeleteUserAttribute Delete /user_attributes/{user_attribute_id} Delete User Attribute
UserAttributeApi SetUserAttributeGroupValues Post /user_attributes/{user_attribute_id}/group_values Set User Attribute Group Values
UserAttributeApi UpdateUserAttribute Patch /user_attributes/{user_attribute_id} Update User Attribute
UserAttributeApi UserAttribute Get /user_attributes/{user_attribute_id} Get User Attribute
WorkspaceApi AllWorkspaces Get /workspaces Get All Workspaces
WorkspaceApi Workspace Get /workspaces/{workspace_id} Get Workspace

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

support@looker.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ApiAuthApi *ApiAuthApiService

	AuthApi *AuthApiService

	ColorCollectionApi *ColorCollectionApiService

	ConfigApi *ConfigApiService

	ConnectionApi *ConnectionApiService

	ContentApi *ContentApiService

	DashboardApi *DashboardApiService

	DataActionApi *DataActionApiService

	DatagroupApi *DatagroupApiService

	FolderApi *FolderApiService

	GroupApi *GroupApiService

	HomepageApi *HomepageApiService

	IntegrationApi *IntegrationApiService

	LookApi *LookApiService

	LookmlModelApi *LookmlModelApiService

	ProjectApi *ProjectApiService

	QueryApi *QueryApiService

	RenderTaskApi *RenderTaskApiService

	RoleApi *RoleApiService

	ScheduledPlanApi *ScheduledPlanApiService

	SessionApi *SessionApiService

	SpaceApi *SpaceApiService

	ThemeApi *ThemeApiService

	UserApi *UserApiService

	UserAttributeApi *UserAttributeApiService

	WorkspaceApi *WorkspaceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Looker API 3.1 Reference API v3.1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AccessToken 

type AccessToken struct {
	// Access Token used for API calls
	AccessToken string `json:"access_token,omitempty"`
	// Type of Token
	TokenType string `json:"token_type,omitempty"`
	// Number of seconds before the token expires
	ExpiresIn int64 `json:"expires_in,omitempty"`
}

AccessToken struct for AccessToken

type ActiveThemesOpts 

type ActiveThemesOpts struct {
	Name   optional.String
	Ts     optional.Time
	Fields optional.String
}

ActiveThemesOpts Optional parameters for the method 'ActiveThemes'

type AllColorCollectionsOpts 

type AllColorCollectionsOpts struct {
	Fields optional.String
}

AllColorCollectionsOpts Optional parameters for the method 'AllColorCollections'

type AllConnectionsOpts 

type AllConnectionsOpts struct {
	Fields optional.String
}

AllConnectionsOpts Optional parameters for the method 'AllConnections'

type AllContentMetadataAccessesOpts 

type AllContentMetadataAccessesOpts struct {
	Fields optional.String
}

AllContentMetadataAccessesOpts Optional parameters for the method 'AllContentMetadataAccesses'

type AllContentMetadatasOpts 

type AllContentMetadatasOpts struct {
	Fields optional.String
}

AllContentMetadatasOpts Optional parameters for the method 'AllContentMetadatas'

type AllDashboardsOpts 

type AllDashboardsOpts struct {
	Fields optional.String
}

AllDashboardsOpts Optional parameters for the method 'AllDashboards'

type AllDialectInfosOpts 

type AllDialectInfosOpts struct {
	Fields optional.String
}

AllDialectInfosOpts Optional parameters for the method 'AllDialectInfos'

type AllFoldersOpts 

type AllFoldersOpts struct {
	Fields optional.String
}

AllFoldersOpts Optional parameters for the method 'AllFolders'

type AllGitConnectionTestsOpts 

type AllGitConnectionTestsOpts struct {
	RemoteUrl optional.String
}

AllGitConnectionTestsOpts Optional parameters for the method 'AllGitConnectionTests'

type AllGroupGroupsOpts 

type AllGroupGroupsOpts struct {
	Fields optional.String
}

AllGroupGroupsOpts Optional parameters for the method 'AllGroupGroups'

type AllGroupUsersOpts 

type AllGroupUsersOpts struct {
	Fields  optional.String
	Page    optional.Int64
	PerPage optional.Int64
	Sorts   optional.String
}

AllGroupUsersOpts Optional parameters for the method 'AllGroupUsers'

type AllGroupsOpts 

type AllGroupsOpts struct {
	Fields                  optional.String
	Page                    optional.Int64
	PerPage                 optional.Int64
	Sorts                   optional.String
	Ids                     optional.Interface
	ContentMetadataId       optional.Int64
	CanAddToContentMetadata optional.Bool
}

AllGroupsOpts Optional parameters for the method 'AllGroups'

type AllHomepageItemsOpts 

type AllHomepageItemsOpts struct {
	Fields            optional.String
	Sorts             optional.String
	HomepageSectionId optional.String
}

AllHomepageItemsOpts Optional parameters for the method 'AllHomepageItems'

type AllHomepageSectionsOpts 

type AllHomepageSectionsOpts struct {
	Fields optional.String
	Sorts  optional.String
}

AllHomepageSectionsOpts Optional parameters for the method 'AllHomepageSections'

type AllHomepagesOpts 

type AllHomepagesOpts struct {
	Fields optional.String
}

AllHomepagesOpts Optional parameters for the method 'AllHomepages'

type AllIntegrationHubsOpts 

type AllIntegrationHubsOpts struct {
	Fields optional.String
}

AllIntegrationHubsOpts Optional parameters for the method 'AllIntegrationHubs'

type AllIntegrationsOpts 

type AllIntegrationsOpts struct {
	Fields           optional.String
	IntegrationHubId optional.String
}

AllIntegrationsOpts Optional parameters for the method 'AllIntegrations'

type AllLookmlModelsOpts 

type AllLookmlModelsOpts struct {
	Fields optional.String
}

AllLookmlModelsOpts Optional parameters for the method 'AllLookmlModels'

type AllLookmlTestsOpts 

type AllLookmlTestsOpts struct {
	FileId optional.String
}

AllLookmlTestsOpts Optional parameters for the method 'AllLookmlTests'

type AllLooksOpts 

type AllLooksOpts struct {
	Fields optional.String
}

AllLooksOpts Optional parameters for the method 'AllLooks'

type AllModelSetsOpts 

type AllModelSetsOpts struct {
	Fields optional.String
}

AllModelSetsOpts Optional parameters for the method 'AllModelSets'

type AllPermissionSetsOpts 

type AllPermissionSetsOpts struct {
	Fields optional.String
}

AllPermissionSetsOpts Optional parameters for the method 'AllPermissionSets'

type AllProjectFilesOpts 

type AllProjectFilesOpts struct {
	Fields optional.String
}

AllProjectFilesOpts Optional parameters for the method 'AllProjectFiles'

type AllProjectsOpts 

type AllProjectsOpts struct {
	Fields optional.String
}

AllProjectsOpts Optional parameters for the method 'AllProjects'

type AllRolesOpts 

type AllRolesOpts struct {
	Fields optional.String
	Ids    optional.Interface
}

AllRolesOpts Optional parameters for the method 'AllRoles'

type AllScheduledPlansOpts 

type AllScheduledPlansOpts struct {
	UserId   optional.Int64
	Fields   optional.String
	AllUsers optional.Bool
}

AllScheduledPlansOpts Optional parameters for the method 'AllScheduledPlans'

type AllSpacesOpts 

type AllSpacesOpts struct {
	Fields optional.String
}

AllSpacesOpts Optional parameters for the method 'AllSpaces'

type AllThemesOpts 

type AllThemesOpts struct {
	Fields optional.String
}

AllThemesOpts Optional parameters for the method 'AllThemes'

type AllUserAttributeGroupValuesOpts 

type AllUserAttributeGroupValuesOpts struct {
	Fields optional.String
}

AllUserAttributeGroupValuesOpts Optional parameters for the method 'AllUserAttributeGroupValues'

type AllUserAttributesOpts 

type AllUserAttributesOpts struct {
	Fields optional.String
	Sorts  optional.String
}

AllUserAttributesOpts Optional parameters for the method 'AllUserAttributes'

type AllUserCredentialsApi3sOpts 

type AllUserCredentialsApi3sOpts struct {
	Fields optional.String
}

AllUserCredentialsApi3sOpts Optional parameters for the method 'AllUserCredentialsApi3s'

type AllUserCredentialsEmbedsOpts 

type AllUserCredentialsEmbedsOpts struct {
	Fields optional.String
}

AllUserCredentialsEmbedsOpts Optional parameters for the method 'AllUserCredentialsEmbeds'

type AllUserLoginLockoutsOpts 

type AllUserLoginLockoutsOpts struct {
	Fields optional.String
}

AllUserLoginLockoutsOpts Optional parameters for the method 'AllUserLoginLockouts'

type AllUserSessionsOpts 

type AllUserSessionsOpts struct {
	Fields optional.String
}

AllUserSessionsOpts Optional parameters for the method 'AllUserSessions'

type AllUsersOpts 

type AllUsersOpts struct {
	Fields  optional.String
	Page    optional.Int64
	PerPage optional.Int64
	Sorts   optional.String
	Ids     optional.Interface
}

AllUsersOpts Optional parameters for the method 'AllUsers'

type ApiAuthApiService 

type ApiAuthApiService service

ApiAuthApiService ApiAuthApi service

func (*ApiAuthApiService) Login 

func (a *ApiAuthApiService) Login(ctx _context.Context, localVarOptionals *LoginOpts) (AccessToken, *_nethttp.Response, error)

Login Login ### Present client credentials to obtain an authorization token Looker API implements the OAuth2 [Resource Owner Password Credentials Grant](https://looker.com/docs/r/api/outh2_resource_owner_pc) pattern. The client credentials required for this login must be obtained by creating an API3 key on a user account in the Looker Admin console. The API3 key consists of a public `client_id` and a private `client_secret`. The access token returned by `login` must be used in the HTTP Authorization header of subsequent API requests, like this: ``` Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4 ``` Replace \"4QDkCy...\" with the `access_token` value returned by `login`. The word `token` is a string literal and must be included exactly as shown. This function can accept `client_id` and `client_secret` parameters as URL query params or as www-form-urlencoded params in the body of the HTTP request. Since there is a small risk that URL parameters may be visible to intermediate nodes on the network route (proxies, routers, etc), passing credentials in the body of the request is considered more secure than URL params. Example of passing credentials in the HTTP request body: ```` POST HTTP /login Content-Type: application/x-www-form-urlencoded client_id=CGc9B7v7J48dQSJvxxx&client_secret=nNVS9cSS3xNpSC9JdsBvvvvv ```` ### Best Practice: Always pass credentials in body params. Pass credentials in URL query params **only** when you cannot pass body params due to application, tool, or other limitations. For more information and detailed examples of Looker API authorization, see [How to Authenticate to Looker API3](https://github.com/looker/looker-sdk-ruby/blob/master/authentication.md).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *LoginOpts - Optional Parameters:
  • @param "ClientId" (optional.String) - client_id part of API3 Key.
  • @param "ClientSecret" (optional.String) - client_secret part of API3 Key.

@return AccessToken

func (*ApiAuthApiService) LoginUser 

func (a *ApiAuthApiService) LoginUser(ctx _context.Context, userId int64) (AccessToken, *_nethttp.Response, error)

LoginUser Login user ### Create an access token for a given user. This can only be called by an authenticated admin user. It allows that admin to generate a new authentication token for the user with the given user id. That token can then be used for subsequent API calls - which are then performed *as* that target user. The target user does *not* need to have a pre-existing API client_id/client_secret pair. And, no such credentials are created by this call. This allows for building systems where api user authentication for an arbitrary number of users is done outside of Looker and funneled through a single 'service account' with admin permissions. Note that a new access token is generated on each call. If target users are going to be making numerous API calls in a short period then it is wise to cache this authentication token rather than call this before each of those API calls. See 'login' for more detail on the access token and how to use it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user.

@return AccessToken

func (*ApiAuthApiService) Logout 

func (a *ApiAuthApiService) Logout(ctx _context.Context) (string, *_nethttp.Response, error)

Logout Logout ### Logout of the API and invalidate the current access token.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

type ApiSession 

type ApiSession struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The id of active workspace for this session
	WorkspaceId string `json:"workspace_id,omitempty"`
	// The id of the actual user in the case when this session represents one user sudo'ing as another
	SudoUserId int64 `json:"sudo_user_id,omitempty"`
}

ApiSession struct for ApiSession

type ApiVersion 

type ApiVersion struct {
	// Current Looker release version number
	LookerReleaseVersion string            `json:"looker_release_version,omitempty"`
	CurrentVersion       ApiVersionElement `json:"current_version,omitempty"`
	// Array of versions supported by this Looker instance
	SupportedVersions []ApiVersionElement `json:"supported_versions,omitempty"`
}

ApiVersion struct for ApiVersion

type ApiVersionElement 

type ApiVersionElement struct {
	// Version number as it appears in '/api/xxx/' urls
	Version string `json:"version,omitempty"`
	// Full version number including minor version
	FullVersion string `json:"full_version,omitempty"`
	// Status of this version
	Status string `json:"status,omitempty"`
	// Url for swagger.json for this version
	SwaggerUrl string `json:"swagger_url,omitempty"`
}

ApiVersionElement struct for ApiVersionElement

type AuthApiService 

type AuthApiService service

AuthApiService AuthApi service

func (*AuthApiService) AllUserLoginLockouts 

func (a *AuthApiService) AllUserLoginLockouts(ctx _context.Context, localVarOptionals *AllUserLoginLockoutsOpts) ([]UserLoginLockout, *_nethttp.Response, error)

AllUserLoginLockouts Get All User Login Lockouts ### Get currently locked-out users.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllUserLoginLockoutsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Include only these fields in the response

@return []UserLoginLockout

func (*AuthApiService) CreateOidcTestConfig 

func (a *AuthApiService) CreateOidcTestConfig(ctx _context.Context, body OidcConfig) (OidcConfig, *_nethttp.Response, error)

CreateOidcTestConfig Create OIDC Test Configuration ### Create a OIDC test configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body OIDC test config

@return OidcConfig

func (*AuthApiService) CreateSamlTestConfig 

func (a *AuthApiService) CreateSamlTestConfig(ctx _context.Context, body SamlConfig) (SamlConfig, *_nethttp.Response, error)

CreateSamlTestConfig Create SAML Test Configuration ### Create a SAML test configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SAML test config

@return SamlConfig

func (*AuthApiService) CreateSsoEmbedUrl 

func (a *AuthApiService) CreateSsoEmbedUrl(ctx _context.Context, body EmbedSsoUrlParams) (EmbedSsoUrl, *_nethttp.Response, error)

CreateSsoEmbedUrl Create SSO Embed Url ### Create SSO Embed URL Creates an SSO embed URL and cryptographically signs it with an embed secret. This signed URL can then be used to instantiate a Looker embed session in a PBL web application. Do not make any modifications to this URL - any change may invalidate the signature and cause the URL to fail to load a Looker embed session. A signed SSO embed URL can only be used once. After it has been used to request a page from the Looker server, the URL is invalid. Future requests using the same URL will fail. This is to prevent 'replay attacks'. The `target_url` property must be a complete URL of a Looker UI page - scheme, hostname, path and query params. To load a dashboard with id 56 and with a filter of `Date=1 years`, the looker URL would look like `https:/myname.looker.com/dashboards/56?Date=1%20years`. The best way to obtain this target_url is to navigate to the desired Looker page in your web browser, copy the URL shown in the browser address bar and paste it into the `target_url` property as a quoted string value in this API request. Permissions for the embed user are defined by the groups in which the embed user is a member (group_ids property) and the lists of models and permissions assigned to the embed user. At a minimum, you must provide values for either the group_ids property, or both the models and permissions properties. These properties are additive; an embed user can be a member of certain groups AND be granted access to models and permissions. The embed user's access is the union of permissions granted by the group_ids, models, and permissions properties. This function does not strictly require all group_ids, user attribute names, or model names to exist at the moment the SSO embed url is created. Unknown group_id, user attribute names or model names will be passed through to the output URL. To diagnose potential problems with an SSO embed URL, you can copy the signed URL into the Embed URI Validator text box in `<your looker instance>/admin/embed`. The `secret_id` parameter is optional. If specified, its value must be the id of an active secret defined in the Looker instance. if not specified, the URL will be signed using the newest active secret defined in the Looker instance. #### Security Note Protect this signed URL as you would an access token or password credentials - do not write it to disk, do not pass it to a third party, and only pass it through a secure HTTPS encrypted transport.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SSO parameters

@return EmbedSsoUrl

func (*AuthApiService) DeleteOidcTestConfig 

func (a *AuthApiService) DeleteOidcTestConfig(ctx _context.Context, testSlug string) (string, *_nethttp.Response, error)

DeleteOidcTestConfig Delete OIDC Test Configuration ### Delete a OIDC test configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testSlug Slug of test config

@return string

func (*AuthApiService) DeleteSamlTestConfig 

func (a *AuthApiService) DeleteSamlTestConfig(ctx _context.Context, testSlug string) (string, *_nethttp.Response, error)

DeleteSamlTestConfig Delete SAML Test Configuration ### Delete a SAML test configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testSlug Slug of test config

@return string

func (*AuthApiService) DeleteUserLoginLockout 

func (a *AuthApiService) DeleteUserLoginLockout(ctx _context.Context, key string) (string, *_nethttp.Response, error)

DeleteUserLoginLockout Delete User Login Lockout ### Removes login lockout for the associated user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key associated with the locked user

@return string

func (*AuthApiService) FetchAndParseSamlIdpMetadata 

func (a *AuthApiService) FetchAndParseSamlIdpMetadata(ctx _context.Context, body string) (SamlMetadataParseResult, *_nethttp.Response, error)

FetchAndParseSamlIdpMetadata Parse SAML IdP Url ### Fetch the given url and parse it as a SAML IdP metadata document and return the result. Note that this requires that the url be public or at least at a location where the Looker instance can fetch it without requiring any special authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SAML IdP metadata public url

@return SamlMetadataParseResult

func (*AuthApiService) ForcePasswordResetAtNextLoginForAllUsers 

func (a *AuthApiService) ForcePasswordResetAtNextLoginForAllUsers(ctx _context.Context) (string, *_nethttp.Response, error)

ForcePasswordResetAtNextLoginForAllUsers Force password reset ### Force all credentials_email users to reset their login passwords upon their next login.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AuthApiService) LdapConfig 

func (a *AuthApiService) LdapConfig(ctx _context.Context) (LdapConfig, *_nethttp.Response, error)

LdapConfig Get LDAP Configuration ### Get the LDAP configuration. Looker can be optionally configured to authenticate users against an Active Directory or other LDAP directory server. LDAP setup requires coordination with an administrator of that directory server. Only Looker administrators can read and update the LDAP configuration. Configuring LDAP impacts authentication for all users. This configuration should be done carefully. Looker maintains a single LDAP configuration. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). LDAP is enabled or disabled for Looker using the **enabled** field. Looker will never return an **auth_password** field. That value can be set, but never retrieved. See the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LdapConfig

func (*AuthApiService) OidcConfig 

func (a *AuthApiService) OidcConfig(ctx _context.Context) (OidcConfig, *_nethttp.Response, error)

OidcConfig Get OIDC Configuration ### Get the OIDC configuration. Looker can be optionally configured to authenticate users against an OpenID Connect (OIDC) authentication server. OIDC setup requires coordination with an administrator of that server. Only Looker administrators can read and update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Looker maintains a single OIDC configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). OIDC is enabled or disabled for Looker using the **enabled** field.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return OidcConfig

func (*AuthApiService) OidcTestConfig 

func (a *AuthApiService) OidcTestConfig(ctx _context.Context, testSlug string) (OidcConfig, *_nethttp.Response, error)

OidcTestConfig Get OIDC Test Configuration ### Get a OIDC test configuration by test_slug.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testSlug Slug of test config

@return OidcConfig

func (*AuthApiService) ParseSamlIdpMetadata 

func (a *AuthApiService) ParseSamlIdpMetadata(ctx _context.Context, body string) (SamlMetadataParseResult, *_nethttp.Response, error)

ParseSamlIdpMetadata Parse SAML IdP XML ### Parse the given xml as a SAML IdP metadata document and return the result.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SAML IdP metadata xml

@return SamlMetadataParseResult

func (*AuthApiService) PasswordConfig 

func (a *AuthApiService) PasswordConfig(ctx _context.Context) (PasswordConfig, *_nethttp.Response, error)

PasswordConfig Get Password Config ### Get password config.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PasswordConfig

func (*AuthApiService) SamlConfig 

func (a *AuthApiService) SamlConfig(ctx _context.Context) (SamlConfig, *_nethttp.Response, error)

SamlConfig Get SAML Configuration ### Get the SAML configuration. Looker can be optionally configured to authenticate users against a SAML authentication server. SAML setup requires coordination with an administrator of that server. Only Looker administrators can read and update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Looker maintains a single SAML configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). SAML is enabled or disabled for Looker using the **enabled** field.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SamlConfig

func (*AuthApiService) SamlTestConfig 

func (a *AuthApiService) SamlTestConfig(ctx _context.Context, testSlug string) (SamlConfig, *_nethttp.Response, error)

SamlTestConfig Get SAML Test Configuration ### Get a SAML test configuration by test_slug.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testSlug Slug of test config

@return SamlConfig

func (*AuthApiService) SearchUserLoginLockouts 

func (a *AuthApiService) SearchUserLoginLockouts(ctx _context.Context, localVarOptionals *SearchUserLoginLockoutsOpts) ([]UserLoginLockout, *_nethttp.Response, error)

SearchUserLoginLockouts Search User Login Lockouts ### Search currently locked-out users.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchUserLoginLockoutsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Include only these fields in the response
  • @param "Page" (optional.Int64) - Return only page N of paginated results
  • @param "PerPage" (optional.Int64) - Return N rows of data per page
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "AuthType" (optional.String) - Auth type user is locked out for (email, ldap, totp, api)
  • @param "FullName" (optional.String) - Match name
  • @param "Email" (optional.String) - Match email
  • @param "RemoteId" (optional.String) - Match remote LDAP ID
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []UserLoginLockout

func (*AuthApiService) SessionConfig 

func (a *AuthApiService) SessionConfig(ctx _context.Context) (SessionConfig, *_nethttp.Response, error)

SessionConfig Get Session Config ### Get session config.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SessionConfig

func (*AuthApiService) TestLdapConfigAuth 

func (a *AuthApiService) TestLdapConfigAuth(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigAuth Test LDAP Auth ### Test the connection authentication settings for an LDAP configuration. This tests that the connection is possible and that a 'server' account to be used by Looker can authenticate to the LDAP server given connection and authentication information. **connection_host**, **connection_port**, and **auth_username**, are required. **connection_tls** and **auth_password** are optional. Example: ```json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true, \"auth_username\": \"cn=looker,dc=example,dc=com\", \"auth_password\": \"secret\" } ``` Looker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test. The active LDAP settings are not modified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigConnection 

func (a *AuthApiService) TestLdapConfigConnection(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigConnection Test LDAP Connection ### Test the connection settings for an LDAP configuration. This tests that the connection is possible given a connection_host and connection_port. **connection_host** and **connection_port** are required. **connection_tls** is optional. Example: ```json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true } ``` No authentication to the LDAP server is attempted. The active LDAP settings are not modified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigUserAuth 

func (a *AuthApiService) TestLdapConfigUserAuth(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigUserAuth Test LDAP User Auth ### Test the user authentication settings for an LDAP configuration. This test accepts a full LDAP configuration along with a username/password pair and attempts to authenticate the user with the LDAP server. The configuration is validated before attempting the authentication. Looker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test. **test_ldap_user** and **test_ldap_password** are required. The active LDAP settings are not modified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigUserInfo 

func (a *AuthApiService) TestLdapConfigUserInfo(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigUserInfo Test LDAP User Info ### Test the user authentication settings for an LDAP configuration without authenticating the user. This test will let you easily test the mapping for user properties and roles for any user without needing to authenticate as that user. This test accepts a full LDAP configuration along with a username and attempts to find the full info for the user from the LDAP server without actually authenticating the user. So, user password is not required.The configuration is validated before attempting to contact the server. **test_ldap_user** is required. The active LDAP settings are not modified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) UpdateLdapConfig 

func (a *AuthApiService) UpdateLdapConfig(ctx _context.Context, body LdapConfig) (LdapConfig, *_nethttp.Response, error)

UpdateLdapConfig Update LDAP Configuration ### Update the LDAP configuration. Configuring LDAP impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the LDAP configuration. LDAP is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any LDAP setting changes be tested using the APIs below before being set globally. See the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LDAP Config

@return LdapConfig

func (*AuthApiService) UpdateOidcConfig 

func (a *AuthApiService) UpdateOidcConfig(ctx _context.Context, body OidcConfig) (OidcConfig, *_nethttp.Response, error)

UpdateOidcConfig Update OIDC Configuration ### Update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the OIDC configuration. OIDC is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any OIDC setting changes be tested using the APIs below before being set globally.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body OIDC Config

@return OidcConfig

func (*AuthApiService) UpdatePasswordConfig 

func (a *AuthApiService) UpdatePasswordConfig(ctx _context.Context, body PasswordConfig) (PasswordConfig, *_nethttp.Response, error)

UpdatePasswordConfig Update Password Config ### Update password config.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Password Config

@return PasswordConfig

func (*AuthApiService) UpdateSamlConfig 

func (a *AuthApiService) UpdateSamlConfig(ctx _context.Context, body SamlConfig) (SamlConfig, *_nethttp.Response, error)

UpdateSamlConfig Update SAML Configuration ### Update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the SAML configuration. SAML is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any SAML setting changes be tested using the APIs below before being set globally.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SAML Config

@return SamlConfig

func (*AuthApiService) UpdateSessionConfig 

func (a *AuthApiService) UpdateSessionConfig(ctx _context.Context, body SessionConfig) (SessionConfig, *_nethttp.Response, error)

UpdateSessionConfig Update Session Config ### Update session config.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Session Config

@return SessionConfig

type BackupConfiguration 

type BackupConfiguration struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Type of backup: looker-s3 or custom-s3
	Type string `json:"type,omitempty"`
	// Name of bucket for custom-s3 backups
	CustomS3Bucket string `json:"custom_s3_bucket,omitempty"`
	// Name of region where the bucket is located
	CustomS3BucketRegion string `json:"custom_s3_bucket_region,omitempty"`
	// (Write-Only) AWS S3 key used for custom-s3 backups
	CustomS3Key string `json:"custom_s3_key,omitempty"`
	// (Write-Only) AWS S3 secret used for custom-s3 backups
	CustomS3Secret string `json:"custom_s3_secret,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

BackupConfiguration struct for BackupConfiguration

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ColorCollection 

type ColorCollection struct {
	// Unique Id
	Id string `json:"id,omitempty"`
	// Label of color collection
	Label string `json:"label,omitempty"`
	// Array of categorical palette definitions
	CategoricalPalettes []DiscretePalette `json:"categoricalPalettes,omitempty"`
	// Array of discrete palette definitions
	SequentialPalettes []ContinuousPalette `json:"sequentialPalettes,omitempty"`
	// Array of diverging palette definitions
	DivergingPalettes []ContinuousPalette `json:"divergingPalettes,omitempty"`
}

ColorCollection struct for ColorCollection

type ColorCollectionApiService 

type ColorCollectionApiService service

ColorCollectionApiService ColorCollectionApi service

func (*ColorCollectionApiService) AllColorCollections 

func (a *ColorCollectionApiService) AllColorCollections(ctx _context.Context, localVarOptionals *AllColorCollectionsOpts) ([]ColorCollection, *_nethttp.Response, error)

AllColorCollections Get all Color Collections ### Get an array of all existing Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllColorCollectionsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) ColorCollection 

func (a *ColorCollectionApiService) ColorCollection(ctx _context.Context, collectionId string, localVarOptionals *ColorCollectionOpts) (ColorCollection, *_nethttp.Response, error)

ColorCollection Get Color Collection by ID ### Get a Color Collection by ID Use this to retrieve a specific Color Collection. Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param collectionId Id of Color Collection
  • @param optional nil or *ColorCollectionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ColorCollection

func (*ColorCollectionApiService) ColorCollectionsCustom 

func (a *ColorCollectionApiService) ColorCollectionsCustom(ctx _context.Context, localVarOptionals *ColorCollectionsCustomOpts) ([]ColorCollection, *_nethttp.Response, error)

ColorCollectionsCustom Get all Custom Color Collections ### Get an array of all existing **Custom** Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ColorCollectionsCustomOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) ColorCollectionsStandard 

func (a *ColorCollectionApiService) ColorCollectionsStandard(ctx _context.Context, localVarOptionals *ColorCollectionsStandardOpts) ([]ColorCollection, *_nethttp.Response, error)

ColorCollectionsStandard Get all Standard Color Collections ### Get an array of all existing **Standard** Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ColorCollectionsStandardOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) CreateColorCollection 

func (a *ColorCollectionApiService) CreateColorCollection(ctx _context.Context, body ColorCollection) (ColorCollection, *_nethttp.Response, error)

CreateColorCollection Create ColorCollection ### Create a custom color collection with the specified information Creates a new custom color collection object, returning the details, including the created id. **Update** an existing color collection with [Update Color Collection](#!/ColorCollection/update_color_collection) **Permanently delete** an existing custom color collection with [Delete Color Collection](#!/ColorCollection/delete_color_collection) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body ColorCollection

@return ColorCollection

func (*ColorCollectionApiService) DefaultColorCollection 

func (a *ColorCollectionApiService) DefaultColorCollection(ctx _context.Context) (ColorCollection, *_nethttp.Response, error)

DefaultColorCollection Get Default Color Collection ### Get the default color collection Use this to retrieve the default Color Collection. Set the default color collection with ColorCollection(#!/ColorCollection/set_default_color_collection)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ColorCollection

func (*ColorCollectionApiService) DeleteColorCollection 

func (a *ColorCollectionApiService) DeleteColorCollection(ctx _context.Context, collectionId string) (*_nethttp.Response, error)

DeleteColorCollection Delete ColorCollection ### Delete a custom color collection by id This operation permanently deletes the identified **Custom** color collection. **Standard** color collections cannot be deleted Because multiple color collections can have the same label, they must be deleted by ID, not name. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param collectionId Id of Color Collection

func (*ColorCollectionApiService) SetDefaultColorCollection 

func (a *ColorCollectionApiService) SetDefaultColorCollection(ctx _context.Context, collectionId string) (ColorCollection, *_nethttp.Response, error)

SetDefaultColorCollection Set Default Color Collection ### Set the global default Color Collection by ID Returns the new specified default Color Collection object. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param collectionId ID of color collection to set as default

@return ColorCollection

func (*ColorCollectionApiService) UpdateColorCollection 

func (a *ColorCollectionApiService) UpdateColorCollection(ctx _context.Context, collectionId string, body ColorCollection) (ColorCollection, *_nethttp.Response, error)

UpdateColorCollection Update Custom Color collection ### Update a custom color collection by id. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param collectionId Id of Custom Color Collection
  • @param body ColorCollection

@return ColorCollection

type ColorCollectionOpts 

type ColorCollectionOpts struct {
	Fields optional.String
}

ColorCollectionOpts Optional parameters for the method 'ColorCollection'

type ColorCollectionsCustomOpts 

type ColorCollectionsCustomOpts struct {
	Fields optional.String
}

ColorCollectionsCustomOpts Optional parameters for the method 'ColorCollectionsCustom'

type ColorCollectionsStandardOpts 

type ColorCollectionsStandardOpts struct {
	Fields optional.String
}

ColorCollectionsStandardOpts Optional parameters for the method 'ColorCollectionsStandard'

type ColorStop 

type ColorStop struct {
	// CSS color string
	Color string `json:"color,omitempty"`
	// Offset in continuous palette (0 to 100)
	Offset int64 `json:"offset,omitempty"`
}

ColorStop struct for ColorStop

type ConfigApiService 

type ConfigApiService service

ConfigApiService ConfigApi service

func (*ConfigApiService) AllLegacyFeatures 

func (a *ConfigApiService) AllLegacyFeatures(ctx _context.Context) ([]LegacyFeature, *_nethttp.Response, error)

AllLegacyFeatures Get All Legacy Features ### Get all legacy features.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []LegacyFeature

func (*ConfigApiService) AllLocales 

func (a *ConfigApiService) AllLocales(ctx _context.Context) ([]Locale, *_nethttp.Response, error)

AllLocales Get All Locales ### Get a list of locales that Looker supports.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Locale

func (*ConfigApiService) AllTimezones 

func (a *ConfigApiService) AllTimezones(ctx _context.Context) ([]Timezone, *_nethttp.Response, error)

AllTimezones Get All Timezones ### Get a list of timezones that Looker supports (e.g. useful for scheduling tasks).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Timezone

func (*ConfigApiService) BackupConfiguration 

func (a *ConfigApiService) BackupConfiguration(ctx _context.Context) (BackupConfiguration, *_nethttp.Response, error)

BackupConfiguration Get Backup Configuration ### Get the current Looker internal database backup configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return BackupConfiguration

func (*ConfigApiService) CustomWelcomeEmail 

func (a *ConfigApiService) CustomWelcomeEmail(ctx _context.Context) (CustomWelcomeEmail, *_nethttp.Response, error)

CustomWelcomeEmail Get Custom Welcome Email ### Get the current status and content of custom welcome emails

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomWelcomeEmail

func (*ConfigApiService) InternalHelpResources 

func (a *ConfigApiService) InternalHelpResources(ctx _context.Context) (InternalHelpResources, *_nethttp.Response, error)

InternalHelpResources Get Internal Help Resources ### Get and set the options for internal help resources

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InternalHelpResources

func (*ConfigApiService) InternalHelpResourcesContent 

func (a *ConfigApiService) InternalHelpResourcesContent(ctx _context.Context) (InternalHelpResourcesContent, *_nethttp.Response, error)

InternalHelpResourcesContent Get Internal Help Resources Content ### Set the menu item name and content for internal help resources

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InternalHelpResourcesContent

func (*ConfigApiService) LegacyFeature 

func (a *ConfigApiService) LegacyFeature(ctx _context.Context, legacyFeatureId int64) (LegacyFeature, *_nethttp.Response, error)

LegacyFeature Get Legacy Feature ### Get information about the legacy feature with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param legacyFeatureId id of legacy feature

@return LegacyFeature

func (*ConfigApiService) UpdateBackupConfiguration 

func (a *ConfigApiService) UpdateBackupConfiguration(ctx _context.Context, body BackupConfiguration) (BackupConfiguration, *_nethttp.Response, error)

UpdateBackupConfiguration Update Backup Configuration ### Update the Looker internal database backup configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Options for Backup Configuration

@return BackupConfiguration

func (*ConfigApiService) UpdateCustomWelcomeEmail 

func (a *ConfigApiService) UpdateCustomWelcomeEmail(ctx _context.Context, body CustomWelcomeEmail, localVarOptionals *UpdateCustomWelcomeEmailOpts) (CustomWelcomeEmail, *_nethttp.Response, error)

UpdateCustomWelcomeEmail Update Custom Welcome Email Content Update custom welcome email setting and values. Optionally send a test email with the new content to the currently logged in user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Custom Welcome Email setting and value to save
  • @param optional nil or *UpdateCustomWelcomeEmailOpts - Optional Parameters:
  • @param "SendTestWelcomeEmail" (optional.Bool) - If true a test email with the content from the request will be sent to the current user after saving

@return CustomWelcomeEmail

func (*ConfigApiService) UpdateCustomWelcomeEmailTest 

func (a *ConfigApiService) UpdateCustomWelcomeEmailTest(ctx _context.Context, body WelcomeEmailTest) (WelcomeEmailTest, *_nethttp.Response, error)

UpdateCustomWelcomeEmailTest Send a test welcome email to the currently logged in user with the supplied content Requests to this endpoint will send a welcome email with the custom content provided in the body to the currently logged in user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Body of the email to be sent.

@return WelcomeEmailTest

func (*ConfigApiService) UpdateInternalHelpResources 

func (a *ConfigApiService) UpdateInternalHelpResources(ctx _context.Context, body InternalHelpResources) (InternalHelpResources, *_nethttp.Response, error)

UpdateInternalHelpResources Update internal help resources configuration Update internal help resources settings

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Custom Welcome Email

@return InternalHelpResources

func (*ConfigApiService) UpdateInternalHelpResourcesContent 

func (a *ConfigApiService) UpdateInternalHelpResourcesContent(ctx _context.Context, body InternalHelpResourcesContent) (InternalHelpResourcesContent, *_nethttp.Response, error)

UpdateInternalHelpResourcesContent Update internal help resources content Update internal help resources content

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Internal Help Resources Content

@return InternalHelpResourcesContent

func (*ConfigApiService) UpdateLegacyFeature 

func (a *ConfigApiService) UpdateLegacyFeature(ctx _context.Context, legacyFeatureId int64, body LegacyFeature) (LegacyFeature, *_nethttp.Response, error)

UpdateLegacyFeature Update Legacy Feature ### Update information about the legacy feature with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param legacyFeatureId id of legacy feature
  • @param body Legacy Feature

@return LegacyFeature

func (*ConfigApiService) UpdateWhitelabelConfiguration 

func (a *ConfigApiService) UpdateWhitelabelConfiguration(ctx _context.Context, body WhitelabelConfiguration) (WhitelabelConfiguration, *_nethttp.Response, error)

UpdateWhitelabelConfiguration Update Whitelabel configuration ### Update the whitelabel configuration

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Whitelabel configuration

@return WhitelabelConfiguration

func (*ConfigApiService) Versions 

func (a *ConfigApiService) Versions(ctx _context.Context, localVarOptionals *VersionsOpts) (ApiVersion, *_nethttp.Response, error)

Versions Get ApiVersion ### Get information about all API versions supported by this Looker instance.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *VersionsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ApiVersion

func (*ConfigApiService) WhitelabelConfiguration 

func (a *ConfigApiService) WhitelabelConfiguration(ctx _context.Context, localVarOptionals *WhitelabelConfigurationOpts) (WhitelabelConfiguration, *_nethttp.Response, error)

WhitelabelConfiguration Get Whitelabel configuration ### This feature is enabled only by special license. ### Gets the whitelabel configuration, which includes hiding documentation links, custom favicon uploading, etc.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *WhitelabelConfigurationOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return WhitelabelConfiguration

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConnectionApiService 

type ConnectionApiService service

ConnectionApiService ConnectionApi service

func (*ConnectionApiService) AllConnections 

func (a *ConnectionApiService) AllConnections(ctx _context.Context, localVarOptionals *AllConnectionsOpts) ([]DbConnection, *_nethttp.Response, error)

AllConnections Get All Connections ### Get information about all connections.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllConnectionsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DbConnection

func (*ConnectionApiService) AllDialectInfos 

func (a *ConnectionApiService) AllDialectInfos(ctx _context.Context, localVarOptionals *AllDialectInfosOpts) ([]DialectInfo, *_nethttp.Response, error)

AllDialectInfos Get All Dialect Infos ### Get information about all dialects.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllDialectInfosOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DialectInfo

func (*ConnectionApiService) Connection 

func (a *ConnectionApiService) Connection(ctx _context.Context, connectionName string, localVarOptionals *ConnectionOpts) (DbConnection, *_nethttp.Response, error)

Connection Get Connection ### Get information about a connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionName Name of connection
  • @param optional nil or *ConnectionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DbConnection

func (*ConnectionApiService) CreateConnection 

func (a *ConnectionApiService) CreateConnection(ctx _context.Context, body DbConnection) (DbConnection, *_nethttp.Response, error)

CreateConnection Create Connection ### Create a connection using the specified configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Connection

@return DbConnection

func (*ConnectionApiService) DeleteConnection 

func (a *ConnectionApiService) DeleteConnection(ctx _context.Context, connectionName string) (string, *_nethttp.Response, error)

DeleteConnection Delete Connection ### Delete a connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionName Name of connection

@return string

func (*ConnectionApiService) DeleteConnectionOverride 

func (a *ConnectionApiService) DeleteConnectionOverride(ctx _context.Context, connectionName string, overrideContext string) (string, *_nethttp.Response, error)

DeleteConnectionOverride Delete Connection Override ### Delete a connection override.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionName Name of connection
  • @param overrideContext Context of connection override

@return string

func (*ConnectionApiService) TestConnection 

func (a *ConnectionApiService) TestConnection(ctx _context.Context, connectionName string, localVarOptionals *TestConnectionOpts) ([]DbConnectionTestResult, *_nethttp.Response, error)

TestConnection Test Connection ### Test an existing connection. Note that a connection's 'dialect' property has a 'connection_tests' property that lists the specific types of tests that the connection supports. This API is rate limited. Unsupported tests in the request will be ignored.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionName Name of connection
  • @param optional nil or *TestConnectionOpts - Optional Parameters:
  • @param "Tests" (optional.Interface of []string) - Array of names of tests to run

@return []DbConnectionTestResult

func (*ConnectionApiService) TestConnectionConfig 

func (a *ConnectionApiService) TestConnectionConfig(ctx _context.Context, body DbConnection, localVarOptionals *TestConnectionConfigOpts) ([]DbConnectionTestResult, *_nethttp.Response, error)

TestConnectionConfig Test Connection Configuration ### Test a connection configuration. Note that a connection's 'dialect' property has a 'connection_tests' property that lists the specific types of tests that the connection supports. This API is rate limited. Unsupported tests in the request will be ignored.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Connection
  • @param optional nil or *TestConnectionConfigOpts - Optional Parameters:
  • @param "Tests" (optional.Interface of []string) - Array of names of tests to run

@return []DbConnectionTestResult

func (*ConnectionApiService) UpdateConnection 

func (a *ConnectionApiService) UpdateConnection(ctx _context.Context, connectionName string, body DbConnection) (DbConnection, *_nethttp.Response, error)

UpdateConnection Update Connection ### Update a connection using the specified configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionName Name of connection
  • @param body Connection

@return DbConnection

type ConnectionOpts 

type ConnectionOpts struct {
	Fields optional.String
}

ConnectionOpts Optional parameters for the method 'Connection'

type ContentApiService 

type ContentApiService service

ContentApiService ContentApi service

func (*ContentApiService) AllContentMetadataAccesses 

func (a *ContentApiService) AllContentMetadataAccesses(ctx _context.Context, contentMetadataId int64, localVarOptionals *AllContentMetadataAccessesOpts) ([]ContentMetaGroupUser, *_nethttp.Response, error)

AllContentMetadataAccesses Get All Content Metadata Accesses ### All content metadata access records for a content metadata item.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentMetadataId Id of content metadata
  • @param optional nil or *AllContentMetadataAccessesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ContentMetaGroupUser

func (*ContentApiService) AllContentMetadatas 

func (a *ContentApiService) AllContentMetadatas(ctx _context.Context, parentId int64, localVarOptionals *AllContentMetadatasOpts) ([]ContentMeta, *_nethttp.Response, error)

AllContentMetadatas Get All Content Metadatas ### Get information about all content metadata in a space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param parentId Parent space of content.
  • @param optional nil or *AllContentMetadatasOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ContentMeta

func (*ContentApiService) ContentFavorite 

func (a *ContentApiService) ContentFavorite(ctx _context.Context, contentFavoriteId int64, localVarOptionals *ContentFavoriteOpts) (ContentFavorite, *_nethttp.Response, error)

ContentFavorite Get Favorite Content ### Get favorite content by its id

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentFavoriteId Id of favorite content
  • @param optional nil or *ContentFavoriteOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ContentFavorite

func (*ContentApiService) ContentMetadata 

func (a *ContentApiService) ContentMetadata(ctx _context.Context, contentMetadataId int64, localVarOptionals *ContentMetadataOpts) (ContentMeta, *_nethttp.Response, error)

ContentMetadata Get Content Metadata ### Get information about an individual content metadata record.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentMetadataId Id of content metadata
  • @param optional nil or *ContentMetadataOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ContentMeta

func (*ContentApiService) ContentValidation 

func (a *ContentApiService) ContentValidation(ctx _context.Context, localVarOptionals *ContentValidationOpts) (ContentValidation, *_nethttp.Response, error)

ContentValidation Validate Content ### Validate All Content Requires Content Validation Labs Feature be enabled Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ContentValidationOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ContentValidation

func (*ContentApiService) CreateContentFavorite 

func (a *ContentApiService) CreateContentFavorite(ctx _context.Context, body ContentFavorite) (ContentFavorite, *_nethttp.Response, error)

CreateContentFavorite Create Favorite Content ### Create favorite content

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Favorite Content

@return ContentFavorite

func (*ContentApiService) CreateContentMetadataAccess 

func (a *ContentApiService) CreateContentMetadataAccess(ctx _context.Context, body ContentMetaGroupUser, localVarOptionals *CreateContentMetadataAccessOpts) (ContentMetaGroupUser, *_nethttp.Response, error)

CreateContentMetadataAccess Create Content Metadata Access ### Create content metadata access.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Content Metadata Access
  • @param optional nil or *CreateContentMetadataAccessOpts - Optional Parameters:
  • @param "SendBoardsNotificationEmail" (optional.Bool) - Optionally sends notification email when granting access to a board.

@return ContentMetaGroupUser

func (*ContentApiService) DeleteContentFavorite 

func (a *ContentApiService) DeleteContentFavorite(ctx _context.Context, contentFavoriteId int64) (string, *_nethttp.Response, error)

DeleteContentFavorite Delete Favorite Content ### Delete favorite content

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentFavoriteId Id of favorite content

@return string

func (*ContentApiService) DeleteContentMetadataAccess 

func (a *ContentApiService) DeleteContentMetadataAccess(ctx _context.Context, contentMetadataAccessId int64) (string, *_nethttp.Response, error)

DeleteContentMetadataAccess Delete Content Metadata Access ### Remove content metadata access.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentMetadataAccessId Id of content metadata access

@return string

func (*ContentApiService) SearchContentFavorites 

func (a *ContentApiService) SearchContentFavorites(ctx _context.Context, localVarOptionals *SearchContentFavoritesOpts) ([]ContentFavorite, *_nethttp.Response, error)

SearchContentFavorites Search Favorite Contents ### Search Favorite Content If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\" example=\"D_m%\" will match \"Damage\" and \"dump\" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \"true\" and \"false\" as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchContentFavoritesOpts - Optional Parameters:
  • @param "Id" (optional.Int64) - Match content favorite id(s)
  • @param "UserId" (optional.Int64) - Match user id(s)
  • @param "ContentMetadataId" (optional.Int64) - Match content metadata id(s)
  • @param "DashboardId" (optional.Int64) - Match dashboard id(s)
  • @param "LookId" (optional.Int64) - Match look id(s)
  • @param "Limit" (optional.Int64) - Number of results to return. (used with offset)
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit)
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Fields" (optional.String) - Requested fields.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []ContentFavorite

func (*ContentApiService) SearchContentViews 

func (a *ContentApiService) SearchContentViews(ctx _context.Context, localVarOptionals *SearchContentViewsOpts) ([]ContentView, *_nethttp.Response, error)

SearchContentViews Search Content Views ### Search Content Views If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\" example=\"D_m%\" will match \"Damage\" and \"dump\" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \"true\" and \"false\" as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchContentViewsOpts - Optional Parameters:
  • @param "ViewCount" (optional.Int64) - Match view count
  • @param "GroupId" (optional.Int64) - Match Group Id
  • @param "LookId" (optional.String) - Match look_id
  • @param "DashboardId" (optional.String) - Match dashboard_id
  • @param "ContentMetadataId" (optional.Int64) - Match content metadata id
  • @param "StartOfWeekDate" (optional.String) - Match start of week date
  • @param "AllTime" (optional.Bool) - True if only all time view records should be returned
  • @param "UserId" (optional.Int64) - Match user id
  • @param "Fields" (optional.String) - Requested fields
  • @param "Limit" (optional.Int64) - Number of results to return. Use with `offset` to manage pagination of results
  • @param "Offset" (optional.Int64) - Number of results to skip before returning data
  • @param "Sorts" (optional.String) - Fields to sort by
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []ContentView

func (*ContentApiService) UpdateContentMetadata 

func (a *ContentApiService) UpdateContentMetadata(ctx _context.Context, contentMetadataId int64, body ContentMeta) (ContentMeta, *_nethttp.Response, error)

UpdateContentMetadata Update Content Metadata ### Move a piece of content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentMetadataId Id of content metadata
  • @param body Content Metadata

@return ContentMeta

func (*ContentApiService) UpdateContentMetadataAccess 

func (a *ContentApiService) UpdateContentMetadataAccess(ctx _context.Context, contentMetadataAccessId int64, body ContentMetaGroupUser) (ContentMetaGroupUser, *_nethttp.Response, error)

UpdateContentMetadataAccess Update Content Metadata Access ### Update type of access for content metadata.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentMetadataAccessId Id of content metadata access
  • @param body Content Metadata Access

@return ContentMetaGroupUser

type ContentFavorite 

type ContentFavorite struct {
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// User Id which owns this ContentFavorite
	UserId int64 `json:"user_id,omitempty"`
	// Content Metadata Id associated with this ContentFavorite
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Id of a look
	LookId int64 `json:"look_id,omitempty"`
	// Id of a dashboard
	DashboardId int64         `json:"dashboard_id,omitempty"`
	Look        LookBasic     `json:"look,omitempty"`
	Dashboard   DashboardBase `json:"dashboard,omitempty"`
}

ContentFavorite struct for ContentFavorite

type ContentFavoriteOpts 

type ContentFavoriteOpts struct {
	Fields optional.String
}

ContentFavoriteOpts Optional parameters for the method 'ContentFavorite'

type ContentMeta 

type ContentMeta struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Name or title of underlying content
	Name string `json:"name,omitempty"`
	// Id of Parent Content
	ParentId int64 `json:"parent_id,omitempty"`
	// Id of associated space when content_type is \"space\"
	SpaceId string `json:"space_id,omitempty"`
	// Id of associated folder when content_type is \"space\"
	FolderId string `json:"folder_id,omitempty"`
	// Id of associated dashboard when content_type is \"dashboard\"
	DashboardId string `json:"dashboard_id,omitempty"`
	// Id of associated look when content_type is \"look\"
	LookId int64 `json:"look_id,omitempty"`
	// Content Type (\"dashboard\", \"look\", or \"space\")
	ContentType string `json:"content_type,omitempty"`
	// Whether content inherits its access levels from parent
	Inherits bool `json:"inherits,omitempty"`
	// Id of Inherited Content
	InheritingId int64 `json:"inheriting_id,omitempty"`
	// Content Slug
	Slug string `json:"slug,omitempty"`
}

ContentMeta struct for ContentMeta

type ContentMetaGroupUser 

type ContentMetaGroupUser struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of associated Content Metadata
	ContentMetadataId string `json:"content_metadata_id,omitempty"`
	// Type of permission: \"view\" or \"edit\" Valid values are: \"view\", \"edit\".
	PermissionType string `json:"permission_type,omitempty"`
	// ID of associated group
	GroupId int64 `json:"group_id,omitempty"`
	// ID of associated user
	UserId int64 `json:"user_id,omitempty"`
}

ContentMetaGroupUser struct for ContentMetaGroupUser

type ContentMetadataOpts 

type ContentMetadataOpts struct {
	Fields optional.String
}

ContentMetadataOpts Optional parameters for the method 'ContentMetadata'

type ContentValidation 

type ContentValidation struct {
	// A list of content errors
	ContentWithErrors []ContentValidatorError `json:"content_with_errors,omitempty"`
	// Duration of content validation in seconds
	ComputationTime float32 `json:"computation_time,omitempty"`
	// The number of looks validated
	TotalLooksValidated int64 `json:"total_looks_validated,omitempty"`
	// The number of dashboard elements validated
	TotalDashboardElementsValidated int64 `json:"total_dashboard_elements_validated,omitempty"`
	// The number of explores used across all content validated
	TotalExploresValidated int64 `json:"total_explores_validated,omitempty"`
}

ContentValidation struct for ContentValidation

type ContentValidationDashboard 

type ContentValidationDashboard struct {
	// Description
	Description string `json:"description,omitempty"`
	// Unique Id
	Id     string                  `json:"id,omitempty"`
	Space  ContentValidationSpace  `json:"space,omitempty"`
	Folder ContentValidationFolder `json:"folder,omitempty"`
	// Dashboard Title
	Title string `json:"title,omitempty"`
}

ContentValidationDashboard struct for ContentValidationDashboard

type ContentValidationDashboardElement 

type ContentValidationDashboardElement struct {
	// Text tile body text
	BodyText string `json:"body_text,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id Of Look
	LookId string `json:"look_id,omitempty"`
	// Note Display
	NoteDisplay string `json:"note_display,omitempty"`
	// Note State
	NoteState string `json:"note_state,omitempty"`
	// Note Text
	NoteText string `json:"note_text,omitempty"`
	// Note Text as Html
	NoteTextAsHtml string `json:"note_text_as_html,omitempty"`
	// Id Of Query
	QueryId int64 `json:"query_id,omitempty"`
	// Text tile subtitle text
	SubtitleText string `json:"subtitle_text,omitempty"`
	// Title of dashboard element
	Title string `json:"title,omitempty"`
	// Whether title is hidden
	TitleHidden bool `json:"title_hidden,omitempty"`
	// Text tile title
	TitleText string `json:"title_text,omitempty"`
	// Type
	Type string `json:"type,omitempty"`
}

ContentValidationDashboardElement struct for ContentValidationDashboardElement

type ContentValidationDashboardFilter 

type ContentValidationDashboardFilter struct {
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// Name of filter
	Name string `json:"name,omitempty"`
	// Title of filter
	Title string `json:"title,omitempty"`
	// Type of filter: one of date, number, string, or field
	Type string `json:"type,omitempty"`
	// Default value of filter
	DefaultValue string `json:"default_value,omitempty"`
	// Model of filter (required if type = field)
	Model string `json:"model,omitempty"`
	// Explore of filter (required if type = field)
	Explore string `json:"explore,omitempty"`
	// Dimension of filter (required if type = field)
	Dimension string `json:"dimension,omitempty"`
}

ContentValidationDashboardFilter struct for ContentValidationDashboardFilter

type ContentValidationError 

type ContentValidationError struct {
	// Error message
	Message string `json:"message,omitempty"`
	// Name of the field involved in the error
	FieldName string `json:"field_name,omitempty"`
	// Name of the model involved in the error
	ModelName string `json:"model_name,omitempty"`
	// Name of the explore involved in the error
	ExploreName string `json:"explore_name,omitempty"`
	// Whether this validation error is removable
	Removable bool `json:"removable,omitempty"`
}

ContentValidationError struct for ContentValidationError

type ContentValidationFolder 

type ContentValidationFolder struct {
	// Unique Name
	Name string `json:"name"`
	// Unique Id
	Id string `json:"id,omitempty"`
}

ContentValidationFolder struct for ContentValidationFolder

type ContentValidationLook 

type ContentValidationLook struct {
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Look Title
	Title  string                  `json:"title,omitempty"`
	Space  ContentValidationSpace  `json:"space,omitempty"`
	Folder ContentValidationFolder `json:"folder,omitempty"`
}

ContentValidationLook struct for ContentValidationLook

type ContentValidationOpts 

type ContentValidationOpts struct {
	Fields optional.String
}

ContentValidationOpts Optional parameters for the method 'ContentValidation'

type ContentValidationSpace 

type ContentValidationSpace struct {
	// Unique Name
	Name string `json:"name"`
	// Unique Id
	Id string `json:"id,omitempty"`
}

ContentValidationSpace struct for ContentValidationSpace

type ContentValidatorError 

type ContentValidatorError struct {
	Look             ContentValidationLook             `json:"look,omitempty"`
	Dashboard        ContentValidationDashboard        `json:"dashboard,omitempty"`
	DashboardElement ContentValidationDashboardElement `json:"dashboard_element,omitempty"`
	DashboardFilter  ContentValidationDashboardFilter  `json:"dashboard_filter,omitempty"`
	// A list of errors found for this piece of content
	Errors []ContentValidationError `json:"errors,omitempty"`
	// An id unique to this piece of content for this validation run
	Id string `json:"id,omitempty"`
}

ContentValidatorError struct for ContentValidatorError

type ContentView 

type ContentView struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Id of viewed Look
	LookId int64 `json:"look_id,omitempty"`
	// Id of the viewed Dashboard
	DashboardId int64 `json:"dashboard_id,omitempty"`
	// Content metadata id of the Look or Dashboard
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Id of user content was viewed by
	UserId int64 `json:"user_id,omitempty"`
	// Id of group content was viewed by
	GroupId int64 `json:"group_id,omitempty"`
	// Number of times piece of content was viewed
	ViewCount int64 `json:"view_count,omitempty"`
	// Number of times piece of content was favorited
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Date the piece of content was last viewed
	LastViewedAt string `json:"last_viewed_at,omitempty"`
	// Week start date for the view and favorite count during that given week
	StartOfWeekDate string `json:"start_of_week_date,omitempty"`
}

ContentView struct for ContentView

type ContinuousPalette 

type ContinuousPalette struct {
	// Unique identity string
	Id string `json:"id,omitempty"`
	// Label for palette
	Label string `json:"label,omitempty"`
	// Type of palette
	Type string `json:"type,omitempty"`
	// Array of ColorStops in the palette
	Stops []ColorStop `json:"stops,omitempty"`
}

ContinuousPalette struct for ContinuousPalette

type CreateContentMetadataAccessOpts 

type CreateContentMetadataAccessOpts struct {
	SendBoardsNotificationEmail optional.Bool
}

CreateContentMetadataAccessOpts Optional parameters for the method 'CreateContentMetadataAccess'

type CreateDashboardElementOpts 

type CreateDashboardElementOpts struct {
	Fields optional.String
}

CreateDashboardElementOpts Optional parameters for the method 'CreateDashboardElement'

type CreateDashboardFilter 

type CreateDashboardFilter struct {
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id"`
	// Name of filter
	Name string `json:"name"`
	// Title of filter
	Title string `json:"title"`
	// Type of filter: one of date, number, string, or field
	Type string `json:"type"`
	// Default value of filter
	DefaultValue string `json:"default_value,omitempty"`
	// Model of filter (required if type = field)
	Model string `json:"model,omitempty"`
	// Explore of filter (required if type = field)
	Explore string `json:"explore,omitempty"`
	// Dimension of filter (required if type = field)
	Dimension string `json:"dimension,omitempty"`
	// Field information
	Field map[string]string `json:"field,omitempty"`
	// Display order of this filter relative to other filters
	Row int64 `json:"row,omitempty"`
	// Array of listeners for faceted filters
	ListensToFilters []string `json:"listens_to_filters,omitempty"`
	// Whether the filter allows multiple filter values
	AllowMultipleValues bool `json:"allow_multiple_values,omitempty"`
	// Whether the filter requires a value to run the dashboard
	Required bool `json:"required,omitempty"`
	// The visual configuration for this filter. Used to set up how the UI for this filter should appear.
	UiConfig map[string]string `json:"ui_config,omitempty"`
}

CreateDashboardFilter struct for CreateDashboardFilter

type CreateDashboardFilterOpts 

type CreateDashboardFilterOpts struct {
	Fields optional.String
}

CreateDashboardFilterOpts Optional parameters for the method 'CreateDashboardFilter'

type CreateDashboardLayoutOpts 

type CreateDashboardLayoutOpts struct {
	Fields optional.String
}

CreateDashboardLayoutOpts Optional parameters for the method 'CreateDashboardLayout'

type CreateDashboardRenderTask 

type CreateDashboardRenderTask struct {
	// Filter values to apply to the dashboard queries, in URL query format
	DashboardFilters string `json:"dashboard_filters,omitempty"`
	// Dashboard layout style: single_column or tiled
	DashboardStyle string `json:"dashboard_style,omitempty"`
}

CreateDashboardRenderTask struct for CreateDashboardRenderTask

type CreateDashboardRenderTaskOpts 

type CreateDashboardRenderTaskOpts struct {
	Fields       optional.String
	PdfPaperSize optional.String
	PdfLandscape optional.Bool
}

CreateDashboardRenderTaskOpts Optional parameters for the method 'CreateDashboardRenderTask'

type CreateFolder 

type CreateFolder struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id"`
}

CreateFolder struct for CreateFolder

type CreateGroupOpts 

type CreateGroupOpts struct {
	Fields optional.String
}

CreateGroupOpts Optional parameters for the method 'CreateGroup'

type CreateHomepageItemOpts 

type CreateHomepageItemOpts struct {
	Fields optional.String
}

CreateHomepageItemOpts Optional parameters for the method 'CreateHomepageItem'

type CreateHomepageOpts 

type CreateHomepageOpts struct {
	Fields optional.String
}

CreateHomepageOpts Optional parameters for the method 'CreateHomepage'

type CreateHomepageSectionOpts 

type CreateHomepageSectionOpts struct {
	Fields optional.String
}

CreateHomepageSectionOpts Optional parameters for the method 'CreateHomepageSection'

type CreateIntegrationHubOpts 

type CreateIntegrationHubOpts struct {
	Fields optional.String
}

CreateIntegrationHubOpts Optional parameters for the method 'CreateIntegrationHub'

type CreateLookOpts 

type CreateLookOpts struct {
	Fields optional.String
}

CreateLookOpts Optional parameters for the method 'CreateLook'

type CreateLookRenderTaskOpts 

type CreateLookRenderTaskOpts struct {
	Fields optional.String
}

CreateLookRenderTaskOpts Optional parameters for the method 'CreateLookRenderTask'

type CreateLookmlDashboardRenderTaskOpts 

type CreateLookmlDashboardRenderTaskOpts struct {
	Fields       optional.String
	PdfPaperSize optional.String
	PdfLandscape optional.Bool
}

CreateLookmlDashboardRenderTaskOpts Optional parameters for the method 'CreateLookmlDashboardRenderTask'

type CreateMergeQueryOpts 

type CreateMergeQueryOpts struct {
	Fields optional.String
	Body   optional.Interface
}

CreateMergeQueryOpts Optional parameters for the method 'CreateMergeQuery'

type CreateQueryOpts 

type CreateQueryOpts struct {
	Fields optional.String
}

CreateQueryOpts Optional parameters for the method 'CreateQuery'

type CreateQueryRenderTaskOpts 

type CreateQueryRenderTaskOpts struct {
	Fields optional.String
}

CreateQueryRenderTaskOpts Optional parameters for the method 'CreateQueryRenderTask'

type CreateQueryTask 

type CreateQueryTask struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of query to run
	QueryId int64 `json:"query_id"`
	// Desired async query result format. Valid values are: \"json\", \"json_detail\", \"json_fe\", \"csv\", \"html\", \"md\", \"txt\", \"xlsx\", \"gsxml\".
	ResultFormat string `json:"result_format"`
	// Source of query task
	Source string `json:"source,omitempty"`
	// Create the task but defer execution
	Deferred bool `json:"deferred,omitempty"`
	// Id of look associated with query.
	LookId int64 `json:"look_id,omitempty"`
	// Id of dashboard associated with query.
	DashboardId string `json:"dashboard_id,omitempty"`
}

CreateQueryTask struct for CreateQueryTask

type CreateQueryTaskOpts 

type CreateQueryTaskOpts struct {
	Limit              optional.Int64
	ApplyFormatting    optional.Bool
	ApplyVis           optional.Bool
	Cache              optional.Bool
	ImageWidth         optional.Int64
	ImageHeight        optional.Int64
	GenerateDrillLinks optional.Bool
	ForceProduction    optional.Bool
	CacheOnly          optional.Bool
	PathPrefix         optional.String
	RebuildPdts        optional.Bool
	ServerTableCalcs   optional.Bool
	Fields             optional.String
}

CreateQueryTaskOpts Optional parameters for the method 'CreateQueryTask'

type CreateSpace 

type CreateSpace struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id"`
}

CreateSpace struct for CreateSpace

type CreateUserAttributeOpts 

type CreateUserAttributeOpts struct {
	Fields optional.String
}

CreateUserAttributeOpts Optional parameters for the method 'CreateUserAttribute'

type CreateUserCredentialsApi3Opts 

type CreateUserCredentialsApi3Opts struct {
	Fields optional.String
	Body   optional.Interface
}

CreateUserCredentialsApi3Opts Optional parameters for the method 'CreateUserCredentialsApi3'

type CreateUserCredentialsEmailOpts 

type CreateUserCredentialsEmailOpts struct {
	Fields optional.String
}

CreateUserCredentialsEmailOpts Optional parameters for the method 'CreateUserCredentialsEmail'

type CreateUserCredentialsEmailPasswordResetOpts 

type CreateUserCredentialsEmailPasswordResetOpts struct {
	Expires optional.Bool
	Fields  optional.String
}

CreateUserCredentialsEmailPasswordResetOpts Optional parameters for the method 'CreateUserCredentialsEmailPasswordReset'

type CreateUserCredentialsTotpOpts 

type CreateUserCredentialsTotpOpts struct {
	Fields optional.String
	Body   optional.Interface
}

CreateUserCredentialsTotpOpts Optional parameters for the method 'CreateUserCredentialsTotp'

type CreateUserOpts 

type CreateUserOpts struct {
	Fields optional.String
	Body   optional.Interface
}

CreateUserOpts Optional parameters for the method 'CreateUser'

type CredentialsApi3 

type CredentialsApi3 struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// API key client_id
	ClientId string `json:"client_id,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsApi3 struct for CredentialsApi3

type CredentialsEmail 

type CredentialsEmail struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// EMail address used for user login
	Email string `json:"email,omitempty"`
	// Force the user to change their password upon their next login
	ForcedPasswordResetAtNextLogin bool `json:"forced_password_reset_at_next_login,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// Url with one-time use secret token that the user can use to reset password
	PasswordResetUrl string `json:"password_reset_url,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
	// Link to get this user
	UserUrl string `json:"user_url,omitempty"`
}

CredentialsEmail struct for CredentialsEmail

type CredentialsEmbed 

type CredentialsEmbed struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// Embedder's id for a group to which this user was added during the most recent login
	ExternalGroupId string `json:"external_group_id,omitempty"`
	// Embedder's unique id for the user
	ExternalUserId string `json:"external_user_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsEmbed struct for CredentialsEmbed

type CredentialsGoogle 

type CredentialsGoogle struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// Google domain
	Domain string `json:"domain,omitempty"`
	// EMail address
	Email string `json:"email,omitempty"`
	// Google's Unique ID for this user
	GoogleUserId string `json:"google_user_id,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsGoogle struct for CredentialsGoogle

type CredentialsLdap 

type CredentialsLdap struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// EMail address
	Email string `json:"email,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// LDAP Distinguished name for this user (as-of the last login)
	LdapDn string `json:"ldap_dn,omitempty"`
	// LDAP Unique ID for this user
	LdapId string `json:"ldap_id,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsLdap struct for CredentialsLdap

type CredentialsLookerOpenid 

type CredentialsLookerOpenid struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// EMail address used for user login
	Email string `json:"email,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// IP address of client for most recent login using credential
	LoggedInIp string `json:"logged_in_ip,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
	// Link to get this user
	UserUrl string `json:"user_url,omitempty"`
}

CredentialsLookerOpenid struct for CredentialsLookerOpenid

type CredentialsOidc 

type CredentialsOidc struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// EMail address
	Email string `json:"email,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// OIDC OP's Unique ID for this user
	OidcUserId string `json:"oidc_user_id,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsOidc struct for CredentialsOidc

type CredentialsSaml 

type CredentialsSaml struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// EMail address
	Email string `json:"email,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Timestamp for most recent login using credential
	LoggedInAt string `json:"logged_in_at,omitempty"`
	// Saml IdP's Unique ID for this user
	SamlUserId string `json:"saml_user_id,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsSaml struct for CredentialsSaml

type CredentialsTotp 

type CredentialsTotp struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for the creation of this credential
	CreatedAt string `json:"created_at,omitempty"`
	// Has this credential been disabled?
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Short name for the type of this kind of credential
	Type string `json:"type,omitempty"`
	// User has verified
	Verified bool `json:"verified,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

CredentialsTotp struct for CredentialsTotp

type CustomWelcomeEmail 

type CustomWelcomeEmail struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// If true, custom email content will replace the default body of welcome emails
	Enabled bool `json:"enabled,omitempty"`
	// The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed.
	Content string `json:"content,omitempty"`
}

CustomWelcomeEmail struct for CustomWelcomeEmail

type Dashboard 

type Dashboard struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Content Favorite Id
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Is Hidden
	Hidden bool `json:"hidden,omitempty"`
	// Unique Id
	Id    string    `json:"id,omitempty"`
	Model LookModel `json:"model,omitempty"`
	// Timezone in which the Dashboard will run by default.
	QueryTimezone string `json:"query_timezone,omitempty"`
	// Is Read-only
	Readonly bool `json:"readonly,omitempty"`
	// Refresh Interval, as a time duration phrase like \"2 hours 30 minutes\". A number with no time units will be interpreted as whole seconds.
	RefreshInterval string `json:"refresh_interval,omitempty"`
	// Refresh Interval in milliseconds
	RefreshIntervalToI int64      `json:"refresh_interval_to_i,omitempty"`
	Space              SpaceBase  `json:"space,omitempty"`
	Folder             FolderBase `json:"folder,omitempty"`
	// Dashboard Title
	Title string `json:"title,omitempty"`
	// Id of User
	UserId int64 `json:"user_id,omitempty"`
	// Background color
	BackgroundColor string `json:"background_color,omitempty"`
	// Time that the Dashboard was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Elements
	DashboardElements []DashboardElement `json:"dashboard_elements,omitempty"`
	// Filters
	DashboardFilters []DashboardFilter `json:"dashboard_filters,omitempty"`
	// Layouts
	DashboardLayouts []DashboardLayout `json:"dashboard_layouts,omitempty"`
	// Whether or not a dashboard is 'soft' deleted.
	Deleted bool `json:"deleted,omitempty"`
	// Time that the Dashboard was 'soft' deleted.
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// Id of User that 'soft' deleted the dashboard.
	DeleterId int64 `json:"deleter_id,omitempty"`
	// Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).
	EditUri string `json:"edit_uri,omitempty"`
	// Number of times favorited
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Time the dashboard was last accessed
	LastAccessedAt time.Time `json:"last_accessed_at,omitempty"`
	// Time last viewed in the Looker web UI
	LastViewedAt time.Time `json:"last_viewed_at,omitempty"`
	// configuration option that governs how dashboard loading will happen.
	LoadConfiguration string `json:"load_configuration,omitempty"`
	// Links this dashboard to a particular LookML dashboard such that calling a **sync** operation on that LookML dashboard will update this dashboard to match.
	LookmlLinkId string `json:"lookml_link_id,omitempty"`
	// Show filters bar.  **Security Note:** This property only affects the *cosmetic* appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does **NOT** prevent users from changing filters by other means. For information on how to set up secure data access control policies, see [Control User Access to Data](https://looker.com/docs/r/api/control-access)
	ShowFiltersBar bool `json:"show_filters_bar,omitempty"`
	// Show title
	ShowTitle bool `json:"show_title,omitempty"`
	// Content Metadata Slug
	Slug string `json:"slug,omitempty"`
	// Id of Space
	SpaceId string `json:"space_id,omitempty"`
	// Id of folder
	FolderId string `json:"folder_id,omitempty"`
	// Color of text on text tiles
	TextTileTextColor string `json:"text_tile_text_color,omitempty"`
	// Tile background color
	TileBackgroundColor string `json:"tile_background_color,omitempty"`
	// Tile text color
	TileTextColor string `json:"tile_text_color,omitempty"`
	// Title color
	TitleColor string `json:"title_color,omitempty"`
	// Number of times viewed in the Looker web UI
	ViewCount int64             `json:"view_count,omitempty"`
	Settings  DashboardSettings `json:"settings,omitempty"`
	// The preferred route for viewing this dashboard (ie: dashboards or dashboards-next)
	PreferredViewer string `json:"preferred_viewer,omitempty"`
}

Dashboard struct for Dashboard

type DashboardApiService 

type DashboardApiService service

DashboardApiService DashboardApi service

func (*DashboardApiService) AllDashboards 

func (a *DashboardApiService) AllDashboards(ctx _context.Context, localVarOptionals *AllDashboardsOpts) ([]DashboardBase, *_nethttp.Response, error)

AllDashboards Get All Dashboards ### Get information about all active dashboards. Returns an array of **abbreviated dashboard objects**. Dashboards marked as deleted are excluded from this list. Get the **full details** of a specific dashboard by id with [dashboard()](#!/Dashboard/dashboard) Find **deleted dashboards** with [search_dashboards()](#!/Dashboard/search_dashboards)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllDashboardsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DashboardBase

func (*DashboardApiService) CreateDashboard 

func (a *DashboardApiService) CreateDashboard(ctx _context.Context, body Dashboard) (Dashboard, *_nethttp.Response, error)

CreateDashboard Create Dashboard ### Create a new dashboard Creates a new dashboard object and returns the details of the newly created dashboard. `Title`, `user_id`, and `space_id` are all required fields. `Space_id` and `user_id` must contain the id of an existing space or user, respectively. A dashboard's `title` must be unique within the space in which it resides. If you receive a 422 error response when creating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data. You can **update** an existing dashboard with [update_dashboard()](#!/Dashboard/update_dashboard) You can **permanently delete** an existing dashboard with [delete_dashboard()](#!/Dashboard/delete_dashboard)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Dashboard

@return Dashboard

func (*DashboardApiService) CreateDashboardElement 

func (a *DashboardApiService) CreateDashboardElement(ctx _context.Context, body DashboardElement, localVarOptionals *CreateDashboardElementOpts) (DashboardElement, *_nethttp.Response, error)

CreateDashboardElement Create DashboardElement ### Create a dashboard element on the dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body DashboardElement
  • @param optional nil or *CreateDashboardElementOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardElement

func (*DashboardApiService) CreateDashboardFilter 

func (a *DashboardApiService) CreateDashboardFilter(ctx _context.Context, body CreateDashboardFilter, localVarOptionals *CreateDashboardFilterOpts) (DashboardFilter, *_nethttp.Response, error)

CreateDashboardFilter Create Dashboard Filter ### Create a dashboard filter on the dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Dashboard Filter
  • @param optional nil or *CreateDashboardFilterOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return DashboardFilter

func (*DashboardApiService) CreateDashboardLayout 

func (a *DashboardApiService) CreateDashboardLayout(ctx _context.Context, body DashboardLayout, localVarOptionals *CreateDashboardLayoutOpts) (DashboardLayout, *_nethttp.Response, error)

CreateDashboardLayout Create DashboardLayout ### Create a dashboard layout on the dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body DashboardLayout
  • @param optional nil or *CreateDashboardLayoutOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardLayout

func (*DashboardApiService) Dashboard 

func (a *DashboardApiService) Dashboard(ctx _context.Context, dashboardId string, localVarOptionals *DashboardOpts) (Dashboard, *_nethttp.Response, error)

Dashboard Get Dashboard ### Get information about a dashboard Returns the full details of the identified dashboard object Get a **summary list** of all active dashboards with [all_dashboards()](#!/Dashboard/all_dashboards) You can **Search** for dashboards with [search_dashboards()](#!/Dashboard/search_dashboards)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard
  • @param optional nil or *DashboardOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Dashboard

func (*DashboardApiService) DashboardDashboardElements 

func (a *DashboardApiService) DashboardDashboardElements(ctx _context.Context, dashboardId string, localVarOptionals *DashboardDashboardElementsOpts) ([]DashboardElement, *_nethttp.Response, error)

DashboardDashboardElements Get All DashboardElements ### Get information about all the dashboard elements on a dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard
  • @param optional nil or *DashboardDashboardElementsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DashboardElement

func (*DashboardApiService) DashboardDashboardFilters 

func (a *DashboardApiService) DashboardDashboardFilters(ctx _context.Context, dashboardId string, localVarOptionals *DashboardDashboardFiltersOpts) ([]DashboardFilter, *_nethttp.Response, error)

DashboardDashboardFilters Get All Dashboard Filters ### Get information about all the dashboard filters on a dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard
  • @param optional nil or *DashboardDashboardFiltersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DashboardFilter

func (*DashboardApiService) DashboardDashboardLayouts 

func (a *DashboardApiService) DashboardDashboardLayouts(ctx _context.Context, dashboardId string, localVarOptionals *DashboardDashboardLayoutsOpts) ([]DashboardLayout, *_nethttp.Response, error)

DashboardDashboardLayouts Get All DashboardLayouts ### Get information about all the dashboard elements on a dashboard with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard
  • @param optional nil or *DashboardDashboardLayoutsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DashboardLayout

func (*DashboardApiService) DashboardElement 

func (a *DashboardApiService) DashboardElement(ctx _context.Context, dashboardElementId string, localVarOptionals *DashboardElementOpts) (DashboardElement, *_nethttp.Response, error)

DashboardElement Get DashboardElement ### Get information about the dashboard element with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardElementId Id of dashboard element
  • @param optional nil or *DashboardElementOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardElement

func (*DashboardApiService) DashboardFilter 

func (a *DashboardApiService) DashboardFilter(ctx _context.Context, dashboardFilterId string, localVarOptionals *DashboardFilterOpts) (DashboardFilter, *_nethttp.Response, error)

DashboardFilter Get Dashboard Filter ### Get information about the dashboard filters with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardFilterId Id of dashboard filters
  • @param optional nil or *DashboardFilterOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardFilter

func (*DashboardApiService) DashboardLayout 

func (a *DashboardApiService) DashboardLayout(ctx _context.Context, dashboardLayoutId string, localVarOptionals *DashboardLayoutOpts) (DashboardLayout, *_nethttp.Response, error)

DashboardLayout Get DashboardLayout ### Get information about the dashboard layouts with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutId Id of dashboard layouts
  • @param optional nil or *DashboardLayoutOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardLayout

func (*DashboardApiService) DashboardLayoutComponent 

func (a *DashboardApiService) DashboardLayoutComponent(ctx _context.Context, dashboardLayoutComponentId string, localVarOptionals *DashboardLayoutComponentOpts) (DashboardLayoutComponent, *_nethttp.Response, error)

DashboardLayoutComponent Get DashboardLayoutComponent ### Get information about the dashboard elements with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutComponentId Id of dashboard layout component
  • @param optional nil or *DashboardLayoutComponentOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardLayoutComponent

func (*DashboardApiService) DashboardLayoutDashboardLayoutComponents 

func (a *DashboardApiService) DashboardLayoutDashboardLayoutComponents(ctx _context.Context, dashboardLayoutId string, localVarOptionals *DashboardLayoutDashboardLayoutComponentsOpts) ([]DashboardLayoutComponent, *_nethttp.Response, error)

DashboardLayoutDashboardLayoutComponents Get All DashboardLayoutComponents ### Get information about all the dashboard layout components for a dashboard layout with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutId Id of dashboard layout component
  • @param optional nil or *DashboardLayoutDashboardLayoutComponentsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []DashboardLayoutComponent

func (*DashboardApiService) DashboardLookml 

func (a *DashboardApiService) DashboardLookml(ctx _context.Context, dashboardId string) (DashboardLookml, *_nethttp.Response, error)

DashboardLookml Get lookml of a UDD ### Get lookml of a UDD Returns a JSON object that contains the dashboard id and the full lookml

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard

@return DashboardLookml

func (*DashboardApiService) DeleteDashboard 

func (a *DashboardApiService) DeleteDashboard(ctx _context.Context, dashboardId string) (string, *_nethttp.Response, error)

DeleteDashboard Delete Dashboard ### Delete the dashboard with the specified id Permanently **deletes** a dashboard. (The dashboard cannot be recovered after this operation.) \"Soft\" delete or hide a dashboard by setting its `deleted` status to `True` with [update_dashboard()](#!/Dashboard/update_dashboard). Note: When a dashboard is deleted in the UI, it is soft deleted. Use this API call to permanently remove it, if desired.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard

@return string

func (*DashboardApiService) DeleteDashboardElement 

func (a *DashboardApiService) DeleteDashboardElement(ctx _context.Context, dashboardElementId string) (string, *_nethttp.Response, error)

DeleteDashboardElement Delete DashboardElement ### Delete a dashboard element with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardElementId Id of dashboard element

@return string

func (*DashboardApiService) DeleteDashboardFilter 

func (a *DashboardApiService) DeleteDashboardFilter(ctx _context.Context, dashboardFilterId string) (string, *_nethttp.Response, error)

DeleteDashboardFilter Delete Dashboard Filter ### Delete a dashboard filter with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardFilterId Id of dashboard filter

@return string

func (*DashboardApiService) DeleteDashboardLayout 

func (a *DashboardApiService) DeleteDashboardLayout(ctx _context.Context, dashboardLayoutId string) (string, *_nethttp.Response, error)

DeleteDashboardLayout Delete DashboardLayout ### Delete a dashboard layout with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutId Id of dashboard layout

@return string

func (*DashboardApiService) ImportLookmlDashboard 

func (a *DashboardApiService) ImportLookmlDashboard(ctx _context.Context, lookmlDashboardId string, spaceId string, localVarOptionals *ImportLookmlDashboardOpts) (Dashboard, *_nethttp.Response, error)

ImportLookmlDashboard Import LookML Dashboard ### Import a LookML dashboard to a space as a UDD Creates a UDD (a dashboard which exists in the Looker database rather than as a LookML file) from the LookML dashboard and puts it in the space specified. The created UDD will have a lookml_link_id which links to the original LookML dashboard. To give the imported dashboard specify a (e.g. title: \"my title\") in the body of your request, otherwise the imported dashboard will have the same title as the original LookML dashboard. For this operation to succeed the user must have permission to see the LookML dashboard in question, and have permission to create content in the space the dashboard is being imported to. **Sync** a linked UDD with [sync_lookml_dashboard()](#!/Dashboard/sync_lookml_dashboard) **Unlink** a linked UDD by setting lookml_link_id to null with [update_dashboard()](#!/Dashboard/update_dashboard)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlDashboardId Id of LookML dashboard
  • @param spaceId Id of space to import the dashboard to
  • @param optional nil or *ImportLookmlDashboardOpts - Optional Parameters:
  • @param "RawLocale" (optional.Bool) - If true, and this dashboard is localized, export it with the raw keys, not localized.
  • @param "Body" (optional.Interface of Dashboard) - Dashboard

@return Dashboard

func (*DashboardApiService) SearchDashboardElements 

func (a *DashboardApiService) SearchDashboardElements(ctx _context.Context, localVarOptionals *SearchDashboardElementsOpts) ([]DashboardElement, *_nethttp.Response, error)

SearchDashboardElements Search Dashboard Elements ### Search Dashboard Elements Returns an **array of DashboardElement objects** that match the specified search criteria. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\" example=\"D_m%\" will match \"Damage\" and \"dump\" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \"true\" and \"false\" as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchDashboardElementsOpts - Optional Parameters:
  • @param "DashboardId" (optional.Int64) - Select elements that refer to a given dashboard id
  • @param "LookId" (optional.Int64) - Select elements that refer to a given look id
  • @param "Title" (optional.String) - Match the title of element
  • @param "Deleted" (optional.Bool) - Select soft-deleted dashboard elements
  • @param "Fields" (optional.String) - Requested fields.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression
  • @param "Sorts" (optional.String) - Fields to sort by. Sortable fields: [:look_id, :dashboard_id, :deleted, :title]

@return []DashboardElement

func (*DashboardApiService) SearchDashboards 

func (a *DashboardApiService) SearchDashboards(ctx _context.Context, localVarOptionals *SearchDashboardsOpts) ([]Dashboard, *_nethttp.Response, error)

SearchDashboards Search Dashboards ### Search Dashboards Returns an **array of dashboard objects** that match the specified search criteria. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\" example=\"D_m%\" will match \"Damage\" and \"dump\" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \"true\" and \"false\" as values. The parameters `limit`, and `offset` are recommended for fetching results in page-size chunks. Get a **single dashboard** by id with [dashboard()](#!/Dashboard/dashboard)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchDashboardsOpts - Optional Parameters:
  • @param "Id" (optional.Int64) - Match dashboard id.
  • @param "Slug" (optional.String) - Match dashboard slug.
  • @param "Title" (optional.String) - Match Dashboard title.
  • @param "Description" (optional.String) - Match Dashboard description.
  • @param "ContentFavoriteId" (optional.Int64) - Filter on a content favorite id.
  • @param "SpaceId" (optional.String) - Filter on a particular space.
  • @param "Deleted" (optional.String) - Filter on dashboards deleted status.
  • @param "UserId" (optional.String) - Filter on dashboards created by a particular user.
  • @param "ViewCount" (optional.String) - Filter on a particular value of view_count
  • @param "ContentMetadataId" (optional.Int64) - Filter on a content favorite id.
  • @param "Curate" (optional.Bool) - Exclude items that exist only in personal spaces other than the users
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Limit" (optional.Int64) - Number of results to return. (used with offset and takes priority over page and per_page)
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
  • @param "Sorts" (optional.String) - One or more fields to sort by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at]
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Dashboard

func (*DashboardApiService) SyncLookmlDashboard 

func (a *DashboardApiService) SyncLookmlDashboard(ctx _context.Context, lookmlDashboardId string, body Dashboard, localVarOptionals *SyncLookmlDashboardOpts) ([]int64, *_nethttp.Response, error)

SyncLookmlDashboard Sync LookML Dashboard ### Update all linked dashboards to match the specified LookML dashboard. Any UDD (a dashboard which exists in the Looker database rather than as a LookML file) which has a `lookml_link_id` property value referring to a LookML dashboard's id (model::dashboardname) will be updated so that it matches the current state of the LookML dashboard. For this operation to succeed the user must have permission to view the LookML dashboard, and only linked dashboards that the user has permission to update will be synced. To **link** or **unlink** a UDD set the `lookml_link_id` property with [update_dashboard()](#!/Dashboard/update_dashboard)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlDashboardId Id of LookML dashboard, in the form 'model::dashboardname'
  • @param body Dashboard
  • @param optional nil or *SyncLookmlDashboardOpts - Optional Parameters:
  • @param "RawLocale" (optional.Bool) - If true, and this dashboard is localized, export it with the raw keys, not localized.

@return []int64

func (*DashboardApiService) UpdateDashboard 

func (a *DashboardApiService) UpdateDashboard(ctx _context.Context, dashboardId string, body Dashboard) (Dashboard, *_nethttp.Response, error)

UpdateDashboard Update Dashboard ### Update a dashboard You can use this function to change the string and integer properties of a dashboard. Nested objects such as filters, dashboard elements, or dashboard layout components cannot be modified by this function - use the update functions for the respective nested object types (like [update_dashboard_filter()](#!/3.1/Dashboard/update_dashboard_filter) to change a filter) to modify nested objects referenced by a dashboard. If you receive a 422 error response when updating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard
  • @param body Dashboard

@return Dashboard

func (*DashboardApiService) UpdateDashboardElement 

func (a *DashboardApiService) UpdateDashboardElement(ctx _context.Context, dashboardElementId string, body DashboardElement, localVarOptionals *UpdateDashboardElementOpts) (DashboardElement, *_nethttp.Response, error)

UpdateDashboardElement Update DashboardElement ### Update the dashboard element with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardElementId Id of dashboard element
  • @param body DashboardElement
  • @param optional nil or *UpdateDashboardElementOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardElement

func (*DashboardApiService) UpdateDashboardFilter 

func (a *DashboardApiService) UpdateDashboardFilter(ctx _context.Context, dashboardFilterId string, body DashboardFilter, localVarOptionals *UpdateDashboardFilterOpts) (DashboardFilter, *_nethttp.Response, error)

UpdateDashboardFilter Update Dashboard Filter ### Update the dashboard filter with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardFilterId Id of dashboard filter
  • @param body Dashboard Filter
  • @param optional nil or *UpdateDashboardFilterOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardFilter

func (*DashboardApiService) UpdateDashboardLayout 

func (a *DashboardApiService) UpdateDashboardLayout(ctx _context.Context, dashboardLayoutId string, body DashboardLayout, localVarOptionals *UpdateDashboardLayoutOpts) (DashboardLayout, *_nethttp.Response, error)

UpdateDashboardLayout Update DashboardLayout ### Update the dashboard layout with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutId Id of dashboard layout
  • @param body DashboardLayout
  • @param optional nil or *UpdateDashboardLayoutOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardLayout

func (*DashboardApiService) UpdateDashboardLayoutComponent 

func (a *DashboardApiService) UpdateDashboardLayoutComponent(ctx _context.Context, dashboardLayoutComponentId string, body DashboardLayoutComponent, localVarOptionals *UpdateDashboardLayoutComponentOpts) (DashboardLayoutComponent, *_nethttp.Response, error)

UpdateDashboardLayoutComponent Update DashboardLayoutComponent ### Update the dashboard element with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardLayoutComponentId Id of dashboard layout component
  • @param body DashboardLayoutComponent
  • @param optional nil or *UpdateDashboardLayoutComponentOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return DashboardLayoutComponent

type DashboardBase 

type DashboardBase struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Content Favorite Id
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Is Hidden
	Hidden bool `json:"hidden,omitempty"`
	// Unique Id
	Id    string    `json:"id,omitempty"`
	Model LookModel `json:"model,omitempty"`
	// Timezone in which the Dashboard will run by default.
	QueryTimezone string `json:"query_timezone,omitempty"`
	// Is Read-only
	Readonly bool `json:"readonly,omitempty"`
	// Refresh Interval, as a time duration phrase like \"2 hours 30 minutes\". A number with no time units will be interpreted as whole seconds.
	RefreshInterval string `json:"refresh_interval,omitempty"`
	// Refresh Interval in milliseconds
	RefreshIntervalToI int64      `json:"refresh_interval_to_i,omitempty"`
	Space              SpaceBase  `json:"space,omitempty"`
	Folder             FolderBase `json:"folder,omitempty"`
	// Dashboard Title
	Title string `json:"title,omitempty"`
	// Id of User
	UserId int64 `json:"user_id,omitempty"`
}

DashboardBase struct for DashboardBase

type DashboardDashboardElementsOpts 

type DashboardDashboardElementsOpts struct {
	Fields optional.String
}

DashboardDashboardElementsOpts Optional parameters for the method 'DashboardDashboardElements'

type DashboardDashboardFiltersOpts 

type DashboardDashboardFiltersOpts struct {
	Fields optional.String
}

DashboardDashboardFiltersOpts Optional parameters for the method 'DashboardDashboardFilters'

type DashboardDashboardLayoutsOpts 

type DashboardDashboardLayoutsOpts struct {
	Fields optional.String
}

DashboardDashboardLayoutsOpts Optional parameters for the method 'DashboardDashboardLayouts'

type DashboardElement 

type DashboardElement struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Text tile body text
	BodyText string `json:"body_text,omitempty"`
	// Text tile body text as Html
	BodyTextAsHtml string `json:"body_text_as_html,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).
	EditUri string `json:"edit_uri,omitempty"`
	// Unique Id
	Id   string        `json:"id,omitempty"`
	Look LookWithQuery `json:"look,omitempty"`
	// Id Of Look
	LookId string `json:"look_id,omitempty"`
	// LookML link ID
	LookmlLinkId string `json:"lookml_link_id,omitempty"`
	// ID of merge result
	MergeResultId string `json:"merge_result_id,omitempty"`
	// Note Display
	NoteDisplay string `json:"note_display,omitempty"`
	// Note State
	NoteState string `json:"note_state,omitempty"`
	// Note Text
	NoteText string `json:"note_text,omitempty"`
	// Note Text as Html
	NoteTextAsHtml string `json:"note_text_as_html,omitempty"`
	Query          Query  `json:"query,omitempty"`
	// Id Of Query
	QueryId int64 `json:"query_id,omitempty"`
	// Refresh Interval
	RefreshInterval string `json:"refresh_interval,omitempty"`
	// Refresh Interval as integer
	RefreshIntervalToI int64                                      `json:"refresh_interval_to_i,omitempty"`
	ResultMaker        ResultMakerWithIdVisConfigAndDynamicFields `json:"result_maker,omitempty"`
	// ID of the ResultMakerLookup entry.
	ResultMakerId int64 `json:"result_maker_id,omitempty"`
	// Text tile subtitle text
	SubtitleText string `json:"subtitle_text,omitempty"`
	// Title of dashboard element
	Title string `json:"title,omitempty"`
	// Whether title is hidden
	TitleHidden bool `json:"title_hidden,omitempty"`
	// Text tile title
	TitleText string `json:"title_text,omitempty"`
	// Type
	Type string `json:"type,omitempty"`
	// Count of Alerts associated to a dashboard element
	AlertCount int64 `json:"alert_count,omitempty"`
}

DashboardElement struct for DashboardElement

type DashboardElementOpts 

type DashboardElementOpts struct {
	Fields optional.String
}

DashboardElementOpts Optional parameters for the method 'DashboardElement'

type DashboardFilter 

type DashboardFilter struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// Name of filter
	Name string `json:"name,omitempty"`
	// Title of filter
	Title string `json:"title,omitempty"`
	// Type of filter: one of date, number, string, or field
	Type string `json:"type,omitempty"`
	// Default value of filter
	DefaultValue string `json:"default_value,omitempty"`
	// Model of filter (required if type = field)
	Model string `json:"model,omitempty"`
	// Explore of filter (required if type = field)
	Explore string `json:"explore,omitempty"`
	// Dimension of filter (required if type = field)
	Dimension string `json:"dimension,omitempty"`
	// Field information
	Field map[string]string `json:"field,omitempty"`
	// Display order of this filter relative to other filters
	Row int64 `json:"row,omitempty"`
	// Array of listeners for faceted filters
	ListensToFilters []string `json:"listens_to_filters,omitempty"`
	// Whether the filter allows multiple filter values
	AllowMultipleValues bool `json:"allow_multiple_values,omitempty"`
	// Whether the filter requires a value to run the dashboard
	Required bool `json:"required,omitempty"`
	// The visual configuration for this filter. Used to set up how the UI for this filter should appear.
	UiConfig map[string]string `json:"ui_config,omitempty"`
}

DashboardFilter struct for DashboardFilter

type DashboardFilterOpts 

type DashboardFilterOpts struct {
	Fields optional.String
}

DashboardFilterOpts Optional parameters for the method 'DashboardFilter'

type DashboardLayout 

type DashboardLayout struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// Type
	Type string `json:"type,omitempty"`
	// Is Active
	Active bool `json:"active,omitempty"`
	// Column Width
	ColumnWidth int64 `json:"column_width,omitempty"`
	// Width
	Width int64 `json:"width,omitempty"`
	// Whether or not the dashboard layout is deleted.
	Deleted bool `json:"deleted,omitempty"`
	// Title extracted from the dashboard this layout represents.
	DashboardTitle string `json:"dashboard_title,omitempty"`
	// Components
	DashboardLayoutComponents []DashboardLayoutComponent `json:"dashboard_layout_components,omitempty"`
}

DashboardLayout struct for DashboardLayout

type DashboardLayoutComponent 

type DashboardLayoutComponent struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of Dashboard Layout
	DashboardLayoutId string `json:"dashboard_layout_id,omitempty"`
	// Id Of Dashboard Element
	DashboardElementId string `json:"dashboard_element_id,omitempty"`
	// Row
	Row int64 `json:"row,omitempty"`
	// Column
	Column int64 `json:"column,omitempty"`
	// Width
	Width int64 `json:"width,omitempty"`
	// Height
	Height int64 `json:"height,omitempty"`
	// Whether or not the dashboard layout component is deleted
	Deleted bool `json:"deleted,omitempty"`
	// Dashboard element title, extracted from the Dashboard Element.
	ElementTitle string `json:"element_title,omitempty"`
	// Whether or not the dashboard element title is displayed.
	ElementTitleHidden bool `json:"element_title_hidden,omitempty"`
	// Visualization type, extracted from a query's vis_config
	VisType string `json:"vis_type,omitempty"`
}

DashboardLayoutComponent struct for DashboardLayoutComponent

type DashboardLayoutComponentOpts 

type DashboardLayoutComponentOpts struct {
	Fields optional.String
}

DashboardLayoutComponentOpts Optional parameters for the method 'DashboardLayoutComponent'

type DashboardLayoutDashboardLayoutComponentsOpts 

type DashboardLayoutDashboardLayoutComponentsOpts struct {
	Fields optional.String
}

DashboardLayoutDashboardLayoutComponentsOpts Optional parameters for the method 'DashboardLayoutDashboardLayoutComponents'

type DashboardLayoutOpts 

type DashboardLayoutOpts struct {
	Fields optional.String
}

DashboardLayoutOpts Optional parameters for the method 'DashboardLayout'

type DashboardLookml 

type DashboardLookml struct {
	// Id of Dashboard
	DashboardId string `json:"dashboard_id,omitempty"`
	// lookml of UDD
	Lookml string `json:"lookml,omitempty"`
}

DashboardLookml struct for DashboardLookml

type DashboardOpts 

type DashboardOpts struct {
	Fields optional.String
}

DashboardOpts Optional parameters for the method 'Dashboard'

type DashboardSettings 

type DashboardSettings struct {
	// Page margin (side) width
	PageSideMargins int64 `json:"page_side_margins,omitempty"`
	// Background color for the dashboard
	PageBackgroundColor string `json:"page_background_color,omitempty"`
	// Title alignment on dashboard tiles
	TileTitleAlignment string `json:"tile_title_alignment,omitempty"`
	// Space between tiles
	TileSpaceBetween int64 `json:"tile_space_between,omitempty"`
	// Background color for tiles
	TileBackgroundColor string `json:"tile_background_color,omitempty"`
	// Tile shadow on/off
	TileShadow bool `json:"tile_shadow,omitempty"`
	// Key color
	KeyColor string `json:"key_color,omitempty"`
}

DashboardSettings struct for DashboardSettings

type DataActionApiService 

type DataActionApiService service

DataActionApiService DataActionApi service

func (*DataActionApiService) FetchRemoteDataActionForm 

func (a *DataActionApiService) FetchRemoteDataActionForm(ctx _context.Context, body map[string]string) (DataActionForm, *_nethttp.Response, error)

FetchRemoteDataActionForm Fetch Remote Data Action Form For some data actions, the remote server may supply a form requesting further user input. This endpoint takes a data action, asks the remote server to generate a form for it, and returns that form to you for presentation to the user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Data Action Request

@return DataActionForm

func (*DataActionApiService) PerformDataAction 

func (a *DataActionApiService) PerformDataAction(ctx _context.Context, body DataActionRequest) (DataActionResponse, *_nethttp.Response, error)

PerformDataAction Send a Data Action Perform a data action. The data action object can be obtained from query results, and used to perform an arbitrary action.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Data Action Request

@return DataActionResponse

type DataActionForm 

type DataActionForm struct {
	State DataActionUserState `json:"state,omitempty"`
	// Array of form fields.
	Fields []DataActionFormField `json:"fields,omitempty"`
}

DataActionForm struct for DataActionForm

type DataActionFormField 

type DataActionFormField struct {
	// Name
	Name string `json:"name,omitempty"`
	// Human-readable label
	Label string `json:"label,omitempty"`
	// Description of field
	Description string `json:"description,omitempty"`
	// Type of field.
	Type string `json:"type,omitempty"`
	// Default value of the field.
	Default string `json:"default,omitempty"`
	// The URL for an oauth link, if type is 'oauth_link'.
	OauthUrl string `json:"oauth_url,omitempty"`
	// Whether or not a field supports interactive forms.
	Interactive bool `json:"interactive,omitempty"`
	// Whether or not the field is required. This is a user-interface hint. A user interface displaying this form should not submit it without a value for this field. The action server must also perform this validation.
	Required bool `json:"required,omitempty"`
	// If the form type is 'select', a list of options to be selected from.
	Options []DataActionFormSelectOption `json:"options,omitempty"`
}

DataActionFormField struct for DataActionFormField

type DataActionFormSelectOption 

type DataActionFormSelectOption struct {
	// Name
	Name string `json:"name,omitempty"`
	// Human-readable label
	Label string `json:"label,omitempty"`
}

DataActionFormSelectOption struct for DataActionFormSelectOption

type DataActionRequest 

type DataActionRequest struct {
	// The JSON describing the data action. This JSON should be considered opaque and should be passed through unmodified from the query result it came from.
	Action map[string]string `json:"action,omitempty"`
	// User input for any form values the data action might use.
	FormValues map[string]string `json:"form_values,omitempty"`
}

DataActionRequest struct for DataActionRequest

type DataActionResponse 

type DataActionResponse struct {
	// ID of the webhook event that sent this data action. In some error conditions, this may be null.
	WebhookId string `json:"webhook_id,omitempty"`
	// Whether the data action was successful.
	Success bool `json:"success,omitempty"`
	// When true, indicates that the client should refresh (rerun) the source query because the data may have been changed by the action.
	RefreshQuery     bool            `json:"refresh_query,omitempty"`
	ValidationErrors ValidationError `json:"validation_errors,omitempty"`
	// Optional message returned by the data action server describing the state of the action that took place. This can be used to implement custom failure messages. If a failure is related to a particular form field, the server should send back a validation error instead. The Looker web UI does not currently display any message if the action indicates 'success', but may do so in the future.
	Message string `json:"message,omitempty"`
}

DataActionResponse struct for DataActionResponse

type DataActionUserState 

type DataActionUserState struct {
	// User state data
	Data string `json:"data,omitempty"`
	// Time in seconds until the state needs to be refreshed
	RefreshTime int64 `json:"refresh_time,omitempty"`
}

DataActionUserState struct for DataActionUserState

type Datagroup 

type Datagroup struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// UNIX timestamp at which this entry was created.
	CreatedAt int64 `json:"created_at,omitempty"`
	// Unique ID of the datagroup
	Id string `json:"id,omitempty"`
	// Name of the model containing the datagroup. Unique when combined with name.
	ModelName string `json:"model_name,omitempty"`
	// Name of the datagroup. Unique when combined with model_name.
	Name string `json:"name,omitempty"`
	// UNIX timestamp before which cache entries are considered stale. Cannot be in the future.
	StaleBefore int64 `json:"stale_before,omitempty"`
	// UNIX timestamp at which this entry trigger was last checked.
	TriggerCheckAt int64 `json:"trigger_check_at,omitempty"`
	// The message returned with the error of the last trigger check.
	TriggerError string `json:"trigger_error,omitempty"`
	// The value of the trigger when last checked.
	TriggerValue string `json:"trigger_value,omitempty"`
	// UNIX timestamp at which this entry became triggered. Cannot be in the future.
	TriggeredAt int64 `json:"triggered_at,omitempty"`
}

Datagroup struct for Datagroup

type DatagroupApiService 

type DatagroupApiService service

DatagroupApiService DatagroupApi service

func (*DatagroupApiService) AllDatagroups 

func (a *DatagroupApiService) AllDatagroups(ctx _context.Context) ([]Datagroup, *_nethttp.Response, error)

AllDatagroups Get All Datagroups ### Get information about all datagroups.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Datagroup

func (*DatagroupApiService) Datagroup 

func (a *DatagroupApiService) Datagroup(ctx _context.Context, datagroupId string) (Datagroup, *_nethttp.Response, error)

Datagroup Get Datagroup ### Get information about a datagroup.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param datagroupId ID of datagroup.

@return Datagroup

func (*DatagroupApiService) UpdateDatagroup 

func (a *DatagroupApiService) UpdateDatagroup(ctx _context.Context, datagroupId string, body Datagroup) (Datagroup, *_nethttp.Response, error)

UpdateDatagroup Update Datagroup ### Update a datagroup using the specified params.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param datagroupId ID of datagroup.
  • @param body Datagroup

@return Datagroup

type DbConnection 

type DbConnection struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of the connection. Also used as the unique identifier
	Name    string  `json:"name,omitempty"`
	Dialect Dialect `json:"dialect,omitempty"`
	// SQL Runner snippets for this connection
	Snippets []Snippet `json:"snippets,omitempty"`
	// Host name/address of server
	Host string `json:"host,omitempty"`
	// Port number on server
	Port string `json:"port,omitempty"`
	// Username for server authentication
	Username string `json:"username,omitempty"`
	// (Write-Only) Password for server authentication
	Password string `json:"password,omitempty"`
	// Whether the connection uses OAuth for authentication.
	UsesOauth bool `json:"uses_oauth,omitempty"`
	// (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).
	Certificate string `json:"certificate,omitempty"`
	// (Write-Only) Certificate keyfile type - .json or .p12
	FileType string `json:"file_type,omitempty"`
	// Database name
	Database string `json:"database,omitempty"`
	// Time zone of database
	DbTimezone string `json:"db_timezone,omitempty"`
	// Timezone to use in queries
	QueryTimezone string `json:"query_timezone,omitempty"`
	// Scheme name
	Schema string `json:"schema,omitempty"`
	// Maximum number of concurrent connection to use
	MaxConnections int64 `json:"max_connections,omitempty"`
	// Maximum size of query in GBs (BigQuery only, can be a user_attribute name)
	MaxBillingGigabytes string `json:"max_billing_gigabytes,omitempty"`
	// Use SSL/TLS when connecting to server
	Ssl bool `json:"ssl,omitempty"`
	// Verify the SSL
	VerifySsl bool `json:"verify_ssl,omitempty"`
	// Name of temporary database (if used)
	TmpDbName string `json:"tmp_db_name,omitempty"`
	// Additional params to add to JDBC connection string
	JdbcAdditionalParams string `json:"jdbc_additional_params,omitempty"`
	// Connection Pool Timeout, in seconds
	PoolTimeout int64 `json:"pool_timeout,omitempty"`
	// (Read/Write) SQL Dialect name
	DialectName string `json:"dialect_name,omitempty"`
	// Creation date for this connection
	CreatedAt string `json:"created_at,omitempty"`
	// Id of user who last modified this connection configuration
	UserId string `json:"user_id,omitempty"`
	// Is this an example connection?
	Example bool `json:"example,omitempty"`
	// (Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password
	UserDbCredentials bool `json:"user_db_credentials,omitempty"`
	// Fields whose values map to user attribute names
	UserAttributeFields []string `json:"user_attribute_fields,omitempty"`
	// Cron string specifying when maintenance such as PDT trigger checks and drops should be performed
	MaintenanceCron string `json:"maintenance_cron,omitempty"`
	// Unix timestamp at start of last completed PDT trigger check process
	LastRegenAt string `json:"last_regen_at,omitempty"`
	// Unix timestamp at start of last completed PDT reap process
	LastReapAt string `json:"last_reap_at,omitempty"`
	// Precache tables in the SQL Runner
	SqlRunnerPrecacheTables bool `json:"sql_runner_precache_tables,omitempty"`
	// SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature
	AfterConnectStatements string               `json:"after_connect_statements,omitempty"`
	PdtContextOverride     DbConnectionOverride `json:"pdt_context_override,omitempty"`
	// Is this connection created and managed by Looker
	Managed bool `json:"managed,omitempty"`
}

DbConnection struct for DbConnection

type DbConnectionBase 

type DbConnectionBase struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of the connection. Also used as the unique identifier
	Name    string  `json:"name,omitempty"`
	Dialect Dialect `json:"dialect,omitempty"`
	// SQL Runner snippets for this connection
	Snippets []Snippet `json:"snippets,omitempty"`
}

DbConnectionBase struct for DbConnectionBase

type DbConnectionOverride 

type DbConnectionOverride struct {
	// Context in which to override (`pdt` is the only allowed value)
	Context string `json:"context,omitempty"`
	// Host name/address of server
	Host string `json:"host,omitempty"`
	// Port number on server
	Port string `json:"port,omitempty"`
	// Username for server authentication
	Username string `json:"username,omitempty"`
	// (Write-Only) Password for server authentication
	Password string `json:"password,omitempty"`
	// Whether or not the password is overridden in this context
	HasPassword bool `json:"has_password,omitempty"`
	// (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).
	Certificate string `json:"certificate,omitempty"`
	// (Write-Only) Certificate keyfile type - .json or .p12
	FileType string `json:"file_type,omitempty"`
	// Database name
	Database string `json:"database,omitempty"`
	// Scheme name
	Schema string `json:"schema,omitempty"`
	// Additional params to add to JDBC connection string
	JdbcAdditionalParams string `json:"jdbc_additional_params,omitempty"`
	// SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature
	AfterConnectStatements string `json:"after_connect_statements,omitempty"`
}

DbConnectionOverride struct for DbConnectionOverride

type DbConnectionTestResult 

type DbConnectionTestResult struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// JDBC connection string. (only populated in the 'connect' test)
	ConnectionString string `json:"connection_string,omitempty"`
	// Result message of test
	Message string `json:"message,omitempty"`
	// Name of test
	Name string `json:"name,omitempty"`
	// Result code of test
	Status string `json:"status,omitempty"`
}

DbConnectionTestResult struct for DbConnectionTestResult

type DefaultThemeOpts 

type DefaultThemeOpts struct {
	Ts optional.Time
}

DefaultThemeOpts Optional parameters for the method 'DefaultTheme'

type Dialect 

type Dialect struct {
	// The name of the dialect
	Name string `json:"name,omitempty"`
	// The human-readable label of the connection
	Label string `json:"label,omitempty"`
	// Whether the dialect supports query cost estimates
	SupportsCostEstimate bool `json:"supports_cost_estimate,omitempty"`
	// PDT index columns
	PersistentTableIndexes string `json:"persistent_table_indexes,omitempty"`
	// PDT sortkey columns
	PersistentTableSortkeys string `json:"persistent_table_sortkeys,omitempty"`
	// PDT distkey column
	PersistentTableDistkey string `json:"persistent_table_distkey,omitempty"`
	// Suports streaming results
	SupportsStreaming bool `json:"supports_streaming,omitempty"`
	// Should SQL Runner snippets automatically be run
	AutomaticallyRunSqlRunnerSnippets bool `json:"automatically_run_sql_runner_snippets,omitempty"`
	// Array of names of the tests that can be run on a connection using this dialect
	ConnectionTests []string `json:"connection_tests,omitempty"`
	// Is supported with the inducer (i.e. generate from sql)
	SupportsInducer bool `json:"supports_inducer,omitempty"`
	// Can multiple databases be accessed from a connection using this dialect
	SupportsMultipleDatabases bool `json:"supports_multiple_databases,omitempty"`
	// Whether the dialect supports allowing Looker to build persistent derived tables
	SupportsPersistentDerivedTables bool `json:"supports_persistent_derived_tables,omitempty"`
	// Does the database have client SSL support settable through the JDBC string explicitly?
	HasSslSupport bool `json:"has_ssl_support,omitempty"`
}

Dialect struct for Dialect

type DialectInfo 

type DialectInfo struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Default number max connections
	DefaultMaxConnections string `json:"default_max_connections,omitempty"`
	// Default port number
	DefaultPort string `json:"default_port,omitempty"`
	// Is the supporting driver installed
	Installed bool `json:"installed,omitempty"`
	// The human-readable label of the connection
	Label string `json:"label,omitempty"`
	// What the dialect calls the equivalent of a normal SQL table
	LabelForDatabaseEquivalent string `json:"label_for_database_equivalent,omitempty"`
	// The name of the dialect
	Name             string             `json:"name,omitempty"`
	SupportedOptions DialectInfoOptions `json:"supported_options,omitempty"`
}

DialectInfo struct for DialectInfo

type DialectInfoOptions 

type DialectInfoOptions struct {
	// Has additional params support
	AdditionalParams bool `json:"additional_params,omitempty"`
	// Has auth support
	Auth bool `json:"auth,omitempty"`
	// Has host support
	Host bool `json:"host,omitempty"`
	// Has support for a service account
	OauthCredentials bool `json:"oauth_credentials,omitempty"`
	// Has project name support
	ProjectName bool `json:"project_name,omitempty"`
	// Has schema support
	Schema bool `json:"schema,omitempty"`
	// Has SSL support
	Ssl bool `json:"ssl,omitempty"`
	// Has timezone support
	Timezone bool `json:"timezone,omitempty"`
	// Has tmp table support
	TmpTable bool `json:"tmp_table,omitempty"`
	// Username is required
	UsernameRequired bool `json:"username_required,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

DialectInfoOptions struct for DialectInfoOptions

type DiscretePalette 

type DiscretePalette struct {
	// Unique identity string
	Id string `json:"id,omitempty"`
	// Label for palette
	Label string `json:"label,omitempty"`
	// Type of palette
	Type string `json:"type,omitempty"`
	// Array of colors in the palette
	Colors []string `json:"colors,omitempty"`
}

DiscretePalette struct for DiscretePalette

type EmbedSsoUrl 

type EmbedSsoUrl struct {
	// The signed embed URL. Any modification to this string will invalidate the signature and make the URL unusable.
	Url string `json:"url,omitempty"`
}

EmbedSsoUrl struct for EmbedSsoUrl

type EmbedSsoUrlParams 

type EmbedSsoUrlParams struct {
	// The complete URL of the Looker UI page to display in the embed context. For example, to display the dashboard with id 34, `target_url` would look like: `https://mycompany.looker.com:9999/dashboards/34`. `target_uri` MUST contain a scheme (HTTPS), domain name, and URL path. Port must be included if it is required to reach the Looker server from browser clients. If the Looker instance is behind a load balancer or other proxy, `target_uri` must be the public-facing domain name and port required to reach the Looker instance, not the actual internal network machine name of the Looker instance.
	TargetUrl string `json:"target_url"`
	// Number of seconds the SSO embed session will be valid after the embed session is started. Defaults to 300 seconds. Maximum session length accepted is 2592000 seconds (30 days).
	SessionLength int64 `json:"session_length,omitempty"`
	// A value from an external system that uniquely identifies the embed user. Since the user_ids of Looker embed users may change with every embed session, external_user_id provides a way to assign a known, stable user identifier across multiple embed sessions.
	ExternalUserId string `json:"external_user_id,omitempty"`
	// When true, the embed session will purge any residual Looker login state (such as in browser cookies) before creating a new login state with the given embed user info. Defaults to true.
	ForceLogoutLogin bool `json:"force_logout_login,omitempty"`
	// First name of the embed user. Defaults to 'Embed' if not specified
	FirstName string `json:"first_name,omitempty"`
	// Last name of the embed user. Defaults to 'User' if not specified
	LastName string `json:"last_name,omitempty"`
	// Sets the user timezone for the embed user session, if the User Specific Timezones setting is enabled in the Looker admin settings. A value of `null` forces the embed user to use the Looker Application Default Timezone. You MUST omit this property from the request if the User Specific Timezones setting is disabled. Timezone values are validated against the IANA Timezone standard and can be seen in the Application Time Zone dropdown list on the Looker General Settings admin page.
	UserTimezone string `json:"user_timezone,omitempty"`
	// List of Looker permission names to grant to the embed user. Requested permissions will be filtered to permissions allowed for embed sessions.
	Permissions []string `json:"permissions,omitempty"`
	// List of model names that the embed user may access
	Models []string `json:"models,omitempty"`
	// List of Looker group ids in which to enroll the embed user
	GroupIds []int64 `json:"group_ids,omitempty"`
	// A unique value identifying an embed-exclusive group. Multiple embed users using the same `external_group_id` value will be able to share Looker content with each other. Content and embed users associated with the `external_group_id` will not be accessible to normal Looker users or embed users not associated with this `external_group_id`.
	ExternalGroupId int64 `json:"external_group_id,omitempty"`
	// A dictionary of name-value pairs associating a Looker user attribute name with a value.
	UserAttributes map[string]string `json:"user_attributes,omitempty"`
	// Id of the embed secret to use to sign this SSO url. If specified, the value must be an id of a valid (active) secret defined in the Looker instance. If not specified, the URL will be signed with the newest active embed secret defined in the Looker instance.
	SecretId int64 `json:"secret_id,omitempty"`
}

EmbedSsoUrlParams struct for EmbedSsoUrlParams

type Error 

type Error struct {
	// Error details
	Message string `json:"message"`
	// Documentation link
	DocumentationUrl string `json:"documentation_url"`
}

Error struct for Error

type Folder 

type Folder struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Time the space was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// User Id of Creator
	CreatorId int64 `json:"creator_id,omitempty"`
	// Children Count
	ChildCount int64 `json:"child_count,omitempty"`
	// Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login
	ExternalId string `json:"external_id,omitempty"`
	// Folder is an embed folder
	IsEmbed bool `json:"is_embed,omitempty"`
	// Folder is the root embed shared folder
	IsEmbedSharedRoot bool `json:"is_embed_shared_root,omitempty"`
	// Folder is the root embed users folder
	IsEmbedUsersRoot bool `json:"is_embed_users_root,omitempty"`
	// Folder is a user's personal folder
	IsPersonal bool `json:"is_personal,omitempty"`
	// Folder is descendant of a user's personal folder
	IsPersonalDescendant bool `json:"is_personal_descendant,omitempty"`
	// Folder is the root shared folder
	IsSharedRoot bool `json:"is_shared_root,omitempty"`
	// Folder is the root user folder
	IsUsersRoot bool `json:"is_users_root,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Dashboards
	Dashboards []DashboardBase `json:"dashboards,omitempty"`
	// Looks
	Looks []LookWithDashboards `json:"looks,omitempty"`
}

Folder struct for Folder

type FolderAncestorsOpts 

type FolderAncestorsOpts struct {
	Fields optional.String
}

FolderAncestorsOpts Optional parameters for the method 'FolderAncestors'

type FolderApiService 

type FolderApiService service

FolderApiService FolderApi service

func (*FolderApiService) AllFolders 

func (a *FolderApiService) AllFolders(ctx _context.Context, localVarOptionals *AllFoldersOpts) ([]Folder, *_nethttp.Response, error)

AllFolders Get All Folders ### Get information about all folders.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllFoldersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Folder

func (*FolderApiService) CreateFolder 

func (a *FolderApiService) CreateFolder(ctx _context.Context, body CreateFolder) (Folder, *_nethttp.Response, error)

CreateFolder Create Folder ### Create a folder with specified information. Caller must have permission to edit the parent folder and to create folders, otherwise the request returns 404 Not Found.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Folder parameters

@return Folder

func (*FolderApiService) DeleteFolder 

func (a *FolderApiService) DeleteFolder(ctx _context.Context, folderId string) (string, *_nethttp.Response, error)

DeleteFolder Delete Folder ### Delete the folder with a specific id including any children folders. **DANGER** this will delete all looks and dashboards in the folder.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder

@return string

func (*FolderApiService) Folder 

func (a *FolderApiService) Folder(ctx _context.Context, folderId string, localVarOptionals *FolderOpts) (Folder, *_nethttp.Response, error)

Folder Get Folder ### Get information about the folder with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Folder

func (*FolderApiService) FolderAncestors 

func (a *FolderApiService) FolderAncestors(ctx _context.Context, folderId string, localVarOptionals *FolderAncestorsOpts) ([]Folder, *_nethttp.Response, error)

FolderAncestors Get Folder Ancestors ### Get the ancestors of a folder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderAncestorsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Folder

func (*FolderApiService) FolderChildren 

func (a *FolderApiService) FolderChildren(ctx _context.Context, folderId string, localVarOptionals *FolderChildrenOpts) ([]Folder, *_nethttp.Response, error)

FolderChildren Get Folder Children ### Get the children of a folder.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderChildrenOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Sorts" (optional.String) - Fields to sort by.

@return []Folder

func (*FolderApiService) FolderChildrenSearch 

func (a *FolderApiService) FolderChildrenSearch(ctx _context.Context, folderId string, localVarOptionals *FolderChildrenSearchOpts) ([]Folder, *_nethttp.Response, error)

FolderChildrenSearch Search Folder Children ### Search the children of a folder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderChildrenSearchOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Name" (optional.String) - Match folder name.

@return []Folder

func (*FolderApiService) FolderDashboards 

func (a *FolderApiService) FolderDashboards(ctx _context.Context, folderId string, localVarOptionals *FolderDashboardsOpts) ([]Dashboard, *_nethttp.Response, error)

FolderDashboards Get Folder Dashboards ### Get the dashboards in a folder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderDashboardsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Dashboard

func (*FolderApiService) FolderLooks 

func (a *FolderApiService) FolderLooks(ctx _context.Context, folderId string, localVarOptionals *FolderLooksOpts) ([]LookWithQuery, *_nethttp.Response, error)

FolderLooks Get Folder Looks ### Get the looks in a folder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderLooksOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []LookWithQuery

func (*FolderApiService) FolderParent 

func (a *FolderApiService) FolderParent(ctx _context.Context, folderId string, localVarOptionals *FolderParentOpts) (Folder, *_nethttp.Response, error)

FolderParent Get Folder Parent ### Get the parent of a folder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param optional nil or *FolderParentOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Folder

func (*FolderApiService) SearchFolders 

func (a *FolderApiService) SearchFolders(ctx _context.Context, localVarOptionals *SearchFoldersOpts) ([]Folder, *_nethttp.Response, error)

SearchFolders Search Folders Search for folders by creator id, parent id, name, etc

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchFoldersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Limit" (optional.Int64) - Number of results to return. (used with offset and takes priority over page and per_page)
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Name" (optional.String) - Match Space title.
  • @param "Id" (optional.Int64) - Match Space id
  • @param "ParentId" (optional.String) - Filter on a children of a particular folder.
  • @param "CreatorId" (optional.String) - Filter on folder created by a particular user.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Folder

func (*FolderApiService) UpdateFolder 

func (a *FolderApiService) UpdateFolder(ctx _context.Context, folderId string, body UpdateFolder) (Folder, *_nethttp.Response, error)

UpdateFolder Update Folder ### Update the folder with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId Id of folder
  • @param body Folder parameters

@return Folder

type FolderBase 

type FolderBase struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Time the folder was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// User Id of Creator
	CreatorId int64 `json:"creator_id,omitempty"`
	// Children Count
	ChildCount int64 `json:"child_count,omitempty"`
	// Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login
	ExternalId string `json:"external_id,omitempty"`
	// Folder is an embed folder
	IsEmbed bool `json:"is_embed,omitempty"`
	// Folder is the root embed shared folder
	IsEmbedSharedRoot bool `json:"is_embed_shared_root,omitempty"`
	// Folder is the root embed users folder
	IsEmbedUsersRoot bool `json:"is_embed_users_root,omitempty"`
	// Folder is a user's personal folder
	IsPersonal bool `json:"is_personal,omitempty"`
	// Folder is descendant of a user's personal folder
	IsPersonalDescendant bool `json:"is_personal_descendant,omitempty"`
	// Folder is the root shared folder
	IsSharedRoot bool `json:"is_shared_root,omitempty"`
	// Folder is the root user folder
	IsUsersRoot bool `json:"is_users_root,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

FolderBase struct for FolderBase

type FolderChildrenOpts 

type FolderChildrenOpts struct {
	Fields  optional.String
	Page    optional.Int64
	PerPage optional.Int64
	Sorts   optional.String
}

FolderChildrenOpts Optional parameters for the method 'FolderChildren'

type FolderChildrenSearchOpts 

type FolderChildrenSearchOpts struct {
	Fields optional.String
	Sorts  optional.String
	Name   optional.String
}

FolderChildrenSearchOpts Optional parameters for the method 'FolderChildrenSearch'

type FolderDashboardsOpts 

type FolderDashboardsOpts struct {
	Fields optional.String
}

FolderDashboardsOpts Optional parameters for the method 'FolderDashboards'

type FolderLooksOpts 

type FolderLooksOpts struct {
	Fields optional.String
}

FolderLooksOpts Optional parameters for the method 'FolderLooks'

type FolderOpts 

type FolderOpts struct {
	Fields optional.String
}

FolderOpts Optional parameters for the method 'Folder'

type FolderParentOpts 

type FolderParentOpts struct {
	Fields optional.String
}

FolderParentOpts Optional parameters for the method 'FolderParent'

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GitBranch 

type GitBranch struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The short name on the local. Updating `name` results in `git checkout <new_name>`
	Name string `json:"name,omitempty"`
	// The name of the remote
	Remote string `json:"remote,omitempty"`
	// The short name on the remote
	RemoteName string `json:"remote_name,omitempty"`
	// Name of error
	Error string `json:"error,omitempty"`
	// Message describing an error if present
	Message string `json:"message,omitempty"`
	// Name of the owner of a personal branch
	OwnerName string `json:"owner_name,omitempty"`
	// Whether or not this branch is readonly
	Readonly bool `json:"readonly,omitempty"`
	// Whether or not this branch is a personal branch - readonly for all developers except the owner
	Personal bool `json:"personal,omitempty"`
	// Whether or not a local ref exists for the branch
	IsLocal bool `json:"is_local,omitempty"`
	// Whether or not a remote ref exists for the branch
	IsRemote bool `json:"is_remote,omitempty"`
	// Whether or not this is the production branch
	IsProduction bool `json:"is_production,omitempty"`
	// Number of commits the local branch is ahead of the remote
	AheadCount int64 `json:"ahead_count,omitempty"`
	// Number of commits the local branch is behind the remote
	BehindCount int64 `json:"behind_count,omitempty"`
	// UNIX timestamp at which this branch was last committed.
	CommitAt int64 `json:"commit_at,omitempty"`
	// The resolved ref of this branch. Updating `ref` results in `git reset --hard <new_ref>“.
	Ref string `json:"ref,omitempty"`
	// The resolved ref of this branch remote.
	RemoteRef string `json:"remote_ref,omitempty"`
}

GitBranch struct for GitBranch

type GitConnectionTest 

type GitConnectionTest struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Human readable string describing the test
	Description string `json:"description,omitempty"`
	// A short string, uniquely naming this test
	Id string `json:"id,omitempty"`
}

GitConnectionTest struct for GitConnectionTest

type GitConnectionTestResult 

type GitConnectionTestResult struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// A short string, uniquely naming this test
	Id string `json:"id,omitempty"`
	// Additional data from the test
	Message string `json:"message,omitempty"`
	// Either 'pass' or 'fail'
	Status string `json:"status,omitempty"`
}

GitConnectionTestResult struct for GitConnectionTestResult

type GitStatus 

type GitStatus struct {
	// Git action: add, delete, etc
	Action string `json:"action,omitempty"`
	// When true, changes to the local file conflict with the remote repository
	Conflict bool `json:"conflict,omitempty"`
	// When true, the file can be reverted to an earlier state
	Revertable bool `json:"revertable,omitempty"`
	// Git description of the action
	Text string `json:"text,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

GitStatus struct for GitStatus

type Group 

type Group struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Group can be used in content access controls
	CanAddToContentMetadata bool `json:"can_add_to_content_metadata,omitempty"`
	// Currently logged in user is group member
	ContainsCurrentUser bool `json:"contains_current_user,omitempty"`
	// External Id group if embed group
	ExternalGroupId string `json:"external_group_id,omitempty"`
	// Group membership controlled outside of Looker
	ExternallyManaged bool `json:"externally_managed,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// New users are added to this group by default
	IncludeByDefault bool `json:"include_by_default,omitempty"`
	// Name of group
	Name string `json:"name,omitempty"`
	// Number of users included in this group
	UserCount int64 `json:"user_count,omitempty"`
}

Group struct for Group

type GroupApiService 

type GroupApiService service

GroupApiService GroupApi service

func (*GroupApiService) AddGroupGroup 

func (a *GroupApiService) AddGroupGroup(ctx _context.Context, groupId int64, body GroupIdForGroupInclusion) (Group, *_nethttp.Response, error)

AddGroupGroup Add a Group to Group ### Adds a new group to a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param body Group id to add

@return Group

func (*GroupApiService) AddGroupUser 

func (a *GroupApiService) AddGroupUser(ctx _context.Context, groupId int64, body GroupIdForGroupUserInclusion) (User, *_nethttp.Response, error)

AddGroupUser Add a User to Group ### Adds a new user to a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param body User id to add

@return User

func (*GroupApiService) AllGroupGroups 

func (a *GroupApiService) AllGroupGroups(ctx _context.Context, groupId int64, localVarOptionals *AllGroupGroupsOpts) ([]Group, *_nethttp.Response, error)

AllGroupGroups Get All Groups in Group ### Get information about all the groups in a group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param optional nil or *AllGroupGroupsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Group

func (*GroupApiService) AllGroupUsers 

func (a *GroupApiService) AllGroupUsers(ctx _context.Context, groupId int64, localVarOptionals *AllGroupUsersOpts) ([]User, *_nethttp.Response, error)

AllGroupUsers Get All Users in Group ### Get information about all the users directly included in a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param optional nil or *AllGroupUsersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Sorts" (optional.String) - Fields to sort by.

@return []User

func (*GroupApiService) AllGroups 

func (a *GroupApiService) AllGroups(ctx _context.Context, localVarOptionals *AllGroupsOpts) ([]Group, *_nethttp.Response, error)

AllGroups Get All Groups ### Get information about all groups.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllGroupsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Ids" (optional.Interface of []int64) - Optional of ids to get specific groups.
  • @param "ContentMetadataId" (optional.Int64) - Id of content metadata to which groups must have access.
  • @param "CanAddToContentMetadata" (optional.Bool) - Select only groups that either can/cannot be given access to content.

@return []Group

func (*GroupApiService) CreateGroup 

func (a *GroupApiService) CreateGroup(ctx _context.Context, body Group, localVarOptionals *CreateGroupOpts) (Group, *_nethttp.Response, error)

CreateGroup Create Group ### Creates a new group (admin only).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Group
  • @param optional nil or *CreateGroupOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Group

func (*GroupApiService) DeleteGroup 

func (a *GroupApiService) DeleteGroup(ctx _context.Context, groupId int64) (string, *_nethttp.Response, error)

DeleteGroup Delete Group ### Deletes a group (admin only).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group

@return string

func (*GroupApiService) DeleteGroupFromGroup 

func (a *GroupApiService) DeleteGroupFromGroup(ctx _context.Context, groupId int64, deletingGroupId int64) (*_nethttp.Response, error)

DeleteGroupFromGroup Deletes a Group from Group ### Removes a group from a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param deletingGroupId Id of group to delete

func (*GroupApiService) DeleteGroupUser 

func (a *GroupApiService) DeleteGroupUser(ctx _context.Context, groupId int64, userId int64) (*_nethttp.Response, error)

DeleteGroupUser Remove a User from Group ### Removes a user from a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param userId Id of user to remove from group

func (*GroupApiService) DeleteUserAttributeGroupValue 

func (a *GroupApiService) DeleteUserAttributeGroupValue(ctx _context.Context, groupId int64, userAttributeId int64) (*_nethttp.Response, error)

DeleteUserAttributeGroupValue Delete User Attribute Group Value ### Remove a user attribute value from a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param userAttributeId Id of user attribute

func (*GroupApiService) Group 

func (a *GroupApiService) Group(ctx _context.Context, groupId int64, localVarOptionals *GroupOpts) (Group, *_nethttp.Response, error)

Group Get Group ### Get information about a group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param optional nil or *GroupOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Group

func (*GroupApiService) SearchGroups 

func (a *GroupApiService) SearchGroups(ctx _context.Context, localVarOptionals *SearchGroupsOpts) ([]Group, *_nethttp.Response, error)

SearchGroups Search Groups ### Search groups Returns all group records that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchGroupsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Limit" (optional.Int64) - Number of results to return (used with `offset`).
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any (used with `limit`).
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression
  • @param "Id" (optional.Int64) - Match group id.
  • @param "Name" (optional.String) - Match group name.
  • @param "ExternalGroupId" (optional.Bool) - Match group external_group_id.
  • @param "ExternallyManaged" (optional.Bool) - Match group externally_managed.
  • @param "ExternallyOrphaned" (optional.Bool) - Match group externally_orphaned.

@return []Group

func (*GroupApiService) UpdateGroup 

func (a *GroupApiService) UpdateGroup(ctx _context.Context, groupId int64, body Group, localVarOptionals *UpdateGroupOpts) (Group, *_nethttp.Response, error)

UpdateGroup Update Group ### Updates the a group (admin only).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param body Group
  • @param optional nil or *UpdateGroupOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Group

func (*GroupApiService) UpdateUserAttributeGroupValue 

func (a *GroupApiService) UpdateUserAttributeGroupValue(ctx _context.Context, groupId int64, userAttributeId int64, body UserAttributeGroupValue) (UserAttributeGroupValue, *_nethttp.Response, error)

UpdateUserAttributeGroupValue Set User Attribute Group Value ### Set the value of a user attribute for a group. For information about how user attribute values are calculated, see [Set User Attribute Group Values](#!/UserAttribute/set_user_attribute_group_values).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of group
  • @param userAttributeId Id of user attribute
  • @param body New value for group.

@return UserAttributeGroupValue

type GroupIdForGroupInclusion 

type GroupIdForGroupInclusion struct {
	// Id of group
	GroupId int64 `json:"group_id,omitempty"`
}

GroupIdForGroupInclusion struct for GroupIdForGroupInclusion

type GroupIdForGroupUserInclusion 

type GroupIdForGroupUserInclusion struct {
	// Id of user
	UserId int64 `json:"user_id,omitempty"`
}

GroupIdForGroupUserInclusion struct for GroupIdForGroupUserInclusion

type GroupOpts 

type GroupOpts struct {
	Fields optional.String
}

GroupOpts Optional parameters for the method 'Group'

type Homepage 

type Homepage struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of associated content_metadata record
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Date of homepage creatopm
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Date of homepage deletion
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// Description of homepage
	Description string `json:"description,omitempty"`
	// Sections of the homepage
	HomepageSections []HomepageSection `json:"homepage_sections,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// ids of the homepage sections in the order they should be displayed
	SectionOrder []int64 `json:"section_order,omitempty"`
	// Title of homepage
	Title string `json:"title,omitempty"`
	// Date of last homepage update
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// User id of homepage creator
	UserId int64 `json:"user_id,omitempty"`
	// Whether the homepage is the primary homepage or not
	PrimaryHomepage bool `json:"primary_homepage,omitempty"`
}

Homepage struct for Homepage

type HomepageApiService 

type HomepageApiService service

HomepageApiService HomepageApi service

func (*HomepageApiService) AllHomepageItems 

func (a *HomepageApiService) AllHomepageItems(ctx _context.Context, localVarOptionals *AllHomepageItemsOpts) ([]HomepageItem, *_nethttp.Response, error)

AllHomepageItems Get All Homepage Items ### Get information about all homepage items.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllHomepageItemsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "HomepageSectionId" (optional.String) - Filter to a specific homepage section

@return []HomepageItem

func (*HomepageApiService) AllHomepageSections 

func (a *HomepageApiService) AllHomepageSections(ctx _context.Context, localVarOptionals *AllHomepageSectionsOpts) ([]HomepageSection, *_nethttp.Response, error)

AllHomepageSections Get All Homepage sections ### Get information about all homepage sections.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllHomepageSectionsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Sorts" (optional.String) - Fields to sort by.

@return []HomepageSection

func (*HomepageApiService) AllHomepages 

func (a *HomepageApiService) AllHomepages(ctx _context.Context, localVarOptionals *AllHomepagesOpts) ([]Homepage, *_nethttp.Response, error)

AllHomepages Get All Homepages ### Get information about all homepages.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllHomepagesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Homepage

func (*HomepageApiService) CreateHomepage 

func (a *HomepageApiService) CreateHomepage(ctx _context.Context, body Homepage, localVarOptionals *CreateHomepageOpts) (Homepage, *_nethttp.Response, error)

CreateHomepage Create Homepage ### Create a new homepage.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Homepage
  • @param optional nil or *CreateHomepageOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Homepage

func (*HomepageApiService) CreateHomepageItem 

func (a *HomepageApiService) CreateHomepageItem(ctx _context.Context, body HomepageItem, localVarOptionals *CreateHomepageItemOpts) (HomepageItem, *_nethttp.Response, error)

CreateHomepageItem Create Homepage Item ### Create a new homepage item.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Homepage Item
  • @param optional nil or *CreateHomepageItemOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageItem

func (*HomepageApiService) CreateHomepageSection 

func (a *HomepageApiService) CreateHomepageSection(ctx _context.Context, body HomepageSection, localVarOptionals *CreateHomepageSectionOpts) (HomepageSection, *_nethttp.Response, error)

CreateHomepageSection Create Homepage section ### Create a new homepage section.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Homepage section
  • @param optional nil or *CreateHomepageSectionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageSection

func (*HomepageApiService) DeleteHomepage 

func (a *HomepageApiService) DeleteHomepage(ctx _context.Context, homepageId int64) (string, *_nethttp.Response, error)

DeleteHomepage Delete Homepage ### Delete a homepage.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageId Id of homepage

@return string

func (*HomepageApiService) DeleteHomepageItem 

func (a *HomepageApiService) DeleteHomepageItem(ctx _context.Context, homepageItemId int64) (string, *_nethttp.Response, error)

DeleteHomepageItem Delete Homepage Item ### Delete a homepage item.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageItemId Id of homepage_item

@return string

func (*HomepageApiService) DeleteHomepageSection 

func (a *HomepageApiService) DeleteHomepageSection(ctx _context.Context, homepageSectionId int64) (string, *_nethttp.Response, error)

DeleteHomepageSection Delete Homepage section ### Delete a homepage section.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageSectionId Id of homepage_section

@return string

func (*HomepageApiService) Homepage 

func (a *HomepageApiService) Homepage(ctx _context.Context, homepageId int64, localVarOptionals *HomepageOpts) (Homepage, *_nethttp.Response, error)

Homepage Get Homepage ### Get information about a homepage.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageId Id of homepage
  • @param optional nil or *HomepageOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Homepage

func (*HomepageApiService) HomepageItem 

func (a *HomepageApiService) HomepageItem(ctx _context.Context, homepageItemId int64, localVarOptionals *HomepageItemOpts) (HomepageItem, *_nethttp.Response, error)

HomepageItem Get Homepage Item ### Get information about a homepage item.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageItemId Id of homepage item
  • @param optional nil or *HomepageItemOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageItem

func (*HomepageApiService) HomepageSection 

func (a *HomepageApiService) HomepageSection(ctx _context.Context, homepageSectionId int64, localVarOptionals *HomepageSectionOpts) (HomepageSection, *_nethttp.Response, error)

HomepageSection Get Homepage section ### Get information about a homepage section.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageSectionId Id of homepage section
  • @param optional nil or *HomepageSectionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageSection

func (*HomepageApiService) SearchHomepages 

func (a *HomepageApiService) SearchHomepages(ctx _context.Context, localVarOptionals *SearchHomepagesOpts) ([]Homepage, *_nethttp.Response, error)

SearchHomepages Search Homepages ### Search Homepages If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchHomepagesOpts - Optional Parameters:
  • @param "Title" (optional.String) - Matches homepage title.
  • @param "CreatedAt" (optional.String) - Matches the timestamp for when the homepage was created.
  • @param "FirstName" (optional.String) - The first name of the user who created this homepage.
  • @param "LastName" (optional.String) - The last name of the user who created this homepage.
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Favorited" (optional.Bool) - Return favorited homepages when true.
  • @param "CreatorId" (optional.String) - Filter on homepages created by a particular user.
  • @param "Sorts" (optional.String) - The fields to sort the results by
  • @param "Page" (optional.Int64) - The page to return.
  • @param "PerPage" (optional.Int64) - The number of items in the returned page.
  • @param "Offset" (optional.Int64) - The number of items to skip before returning any. (used with limit and takes priority over page and per_page)
  • @param "Limit" (optional.Int64) - The maximum number of items to return. (used with offset and takes priority over page and per_page)
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Homepage

func (*HomepageApiService) UpdateHomepage 

func (a *HomepageApiService) UpdateHomepage(ctx _context.Context, homepageId int64, body Homepage, localVarOptionals *UpdateHomepageOpts) (Homepage, *_nethttp.Response, error)

UpdateHomepage Update Homepage ### Update a homepage definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageId Id of homepage
  • @param body Homepage
  • @param optional nil or *UpdateHomepageOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Homepage

func (*HomepageApiService) UpdateHomepageItem 

func (a *HomepageApiService) UpdateHomepageItem(ctx _context.Context, homepageItemId int64, body HomepageItem, localVarOptionals *UpdateHomepageItemOpts) (HomepageItem, *_nethttp.Response, error)

UpdateHomepageItem Update Homepage Item ### Update a homepage item definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageItemId Id of homepage item
  • @param body Homepage Item
  • @param optional nil or *UpdateHomepageItemOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageItem

func (*HomepageApiService) UpdateHomepageSection 

func (a *HomepageApiService) UpdateHomepageSection(ctx _context.Context, homepageSectionId int64, body HomepageSection, localVarOptionals *UpdateHomepageSectionOpts) (HomepageSection, *_nethttp.Response, error)

UpdateHomepageSection Update Homepage section ### Update a homepage section definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param homepageSectionId Id of homepage section
  • @param body Homepage section
  • @param optional nil or *UpdateHomepageSectionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return HomepageSection

type HomepageItem 

type HomepageItem struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of user who created the content this item is based on
	ContentCreatedBy string `json:"content_created_by,omitempty"`
	// Content favorite id associated with the item this content is based on
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Content metadata id associated with the item this content is based on
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Last time the content that this item is based on was updated
	ContentUpdatedAt string `json:"content_updated_at,omitempty"`
	// Custom description entered by the user, if present
	CustomDescription string `json:"custom_description,omitempty"`
	// (Write-Only) base64 encoded image data
	CustomImageDataBase64 string `json:"custom_image_data_base64,omitempty"`
	// Custom image_url entered by the user, if present
	CustomImageUrl string `json:"custom_image_url,omitempty"`
	// Custom title entered by the user, if present
	CustomTitle string `json:"custom_title,omitempty"`
	// Custom url entered by the user, if present
	CustomUrl string `json:"custom_url,omitempty"`
	// Dashboard to base this item on
	DashboardId int64 `json:"dashboard_id,omitempty"`
	// The actual description for display
	Description string `json:"description,omitempty"`
	// Number of times content has been favorited, if present
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Associated Homepage Section
	HomepageSectionId string `json:"homepage_section_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// The actual image_url for display
	ImageUrl string `json:"image_url,omitempty"`
	// The container folder name of the content
	Location string `json:"location,omitempty"`
	// Look to base this item on
	LookId int64 `json:"look_id,omitempty"`
	// LookML Dashboard to base this item on
	LookmlDashboardId string `json:"lookml_dashboard_id,omitempty"`
	// An arbitrary integer representing the sort order within the section
	Order int64 `json:"order,omitempty"`
	// Number of seconds it took to fetch the section this item is in
	SectionFetchTime float32 `json:"section_fetch_time,omitempty"`
	// The actual title for display
	Title string `json:"title,omitempty"`
	// The actual url for display
	Url string `json:"url,omitempty"`
	// Whether the custom description should be used instead of the content description, if the item is associated with content
	UseCustomDescription bool `json:"use_custom_description,omitempty"`
	// Whether the custom image should be used instead of the content image, if the item is associated with content
	UseCustomImage bool `json:"use_custom_image,omitempty"`
	// Whether the custom title should be used instead of the content title, if the item is associated with content
	UseCustomTitle bool `json:"use_custom_title,omitempty"`
	// Whether the custom url should be used instead of the content url, if the item is associated with content
	UseCustomUrl bool `json:"use_custom_url,omitempty"`
	// Number of times content has been viewed, if present
	ViewCount int64 `json:"view_count,omitempty"`
}

HomepageItem struct for HomepageItem

type HomepageItemOpts 

type HomepageItemOpts struct {
	Fields optional.String
}

HomepageItemOpts Optional parameters for the method 'HomepageItem'

type HomepageOpts 

type HomepageOpts struct {
	Fields optional.String
}

HomepageOpts Optional parameters for the method 'Homepage'

type HomepageSection 

type HomepageSection struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Time at which this section was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time at which this section was deleted.
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// A URL pointing to a page showing further information about the content in the section.
	DetailUrl string `json:"detail_url,omitempty"`
	// Id reference to parent homepage
	HomepageId int64 `json:"homepage_id,omitempty"`
	// Items in the homepage section
	HomepageItems []HomepageItem `json:"homepage_items,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Is this a header section (has no items)
	IsHeader bool `json:"is_header,omitempty"`
	// ids of the homepage items in the order they should be displayed
	ItemOrder []int64 `json:"item_order,omitempty"`
	// Name of row
	Title string `json:"title,omitempty"`
	// Time at which this section was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Description of the content found in this section.
	Description string `json:"description,omitempty"`
}

HomepageSection struct for HomepageSection

type HomepageSectionOpts 

type HomepageSectionOpts struct {
	Fields optional.String
}

HomepageSectionOpts Optional parameters for the method 'HomepageSection'

type ImportLookmlDashboardOpts 

type ImportLookmlDashboardOpts struct {
	RawLocale optional.Bool
	Body      optional.Interface
}

ImportLookmlDashboardOpts Optional parameters for the method 'ImportLookmlDashboard'

type ImportedProject 

type ImportedProject struct {
	// Dependency name
	Name string `json:"name,omitempty"`
	// Url for a remote dependency
	Url string `json:"url,omitempty"`
	// Ref for a remote dependency
	Ref string `json:"ref,omitempty"`
	// Flag signifying if a dependency is remote or local
	IsRemote bool `json:"is_remote,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

ImportedProject struct for ImportedProject

type Integration 

type Integration struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// ID of the integration.
	Id string `json:"id,omitempty"`
	// ID of the integration hub.
	IntegrationHubId int64 `json:"integration_hub_id,omitempty"`
	// Label for the integration.
	Label string `json:"label,omitempty"`
	// Description of the integration.
	Description string `json:"description,omitempty"`
	// Whether the integration is available to users.
	Enabled bool `json:"enabled,omitempty"`
	// Array of params for the integration.
	Params []IntegrationParam `json:"params,omitempty"`
	// A list of data formats the integration supports. If unspecified, the default is all data formats. Valid values are: \"txt\", \"csv\", \"inline_json\", \"json\", \"json_label\", \"json_detail\", \"json_detail_lite_stream\", \"xlsx\", \"html\", \"wysiwyg_pdf\", \"assembled_pdf\", \"wysiwyg_png\", \"csv_zip\".
	SupportedFormats []string `json:"supported_formats,omitempty"`
	// A list of action types the integration supports. Valid values are: \"cell\", \"query\", \"dashboard\".
	SupportedActionTypes []string `json:"supported_action_types,omitempty"`
	// A list of formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: \"formatted\", \"unformatted\".
	SupportedFormattings []string `json:"supported_formattings,omitempty"`
	// A list of visualization formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: \"apply\", \"noapply\".
	SupportedVisualizationFormattings []string `json:"supported_visualization_formattings,omitempty"`
	// A list of all the download mechanisms the integration supports. The order of values is not significant: Looker will select the most appropriate supported download mechanism for a given query. The integration must ensure it can handle any of the mechanisms it claims to support. If unspecified, this defaults to all download setting values. Valid values are: \"push\", \"url\".
	SupportedDownloadSettings []string `json:"supported_download_settings,omitempty"`
	// URL to an icon for the integration.
	IconUrl string `json:"icon_url,omitempty"`
	// Whether the integration uses oauth.
	UsesOauth bool `json:"uses_oauth,omitempty"`
	// A list of descriptions of required fields that this integration is compatible with. If there are multiple entries in this list, the integration requires more than one field. If unspecified, no fields will be required.
	RequiredFields []IntegrationRequiredField `json:"required_fields,omitempty"`
	// Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.
	DelegateOauth bool `json:"delegate_oauth,omitempty"`
	// Whether the integration is available to users.
	InstalledDelegateOauthTargets []string `json:"installed_delegate_oauth_targets,omitempty"`
}

Integration struct for Integration

type IntegrationApiService 

type IntegrationApiService service

IntegrationApiService IntegrationApi service

func (*IntegrationApiService) AcceptIntegrationHubLegalAgreement 

func (a *IntegrationApiService) AcceptIntegrationHubLegalAgreement(ctx _context.Context, integrationHubId int64) (IntegrationHub, *_nethttp.Response, error)

AcceptIntegrationHubLegalAgreement Accept Integration Hub Legal Agreement Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationHubId Id of integration_hub

@return IntegrationHub

func (*IntegrationApiService) AllIntegrationHubs 

func (a *IntegrationApiService) AllIntegrationHubs(ctx _context.Context, localVarOptionals *AllIntegrationHubsOpts) ([]IntegrationHub, *_nethttp.Response, error)

AllIntegrationHubs Get All Integration Hubs ### Get information about all Integration Hubs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllIntegrationHubsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []IntegrationHub

func (*IntegrationApiService) AllIntegrations 

func (a *IntegrationApiService) AllIntegrations(ctx _context.Context, localVarOptionals *AllIntegrationsOpts) ([]Integration, *_nethttp.Response, error)

AllIntegrations Get All Integrations ### Get information about all Integrations.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllIntegrationsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "IntegrationHubId" (optional.String) - Filter to a specific provider

@return []Integration

func (*IntegrationApiService) CreateIntegrationHub 

func (a *IntegrationApiService) CreateIntegrationHub(ctx _context.Context, body IntegrationHub, localVarOptionals *CreateIntegrationHubOpts) (IntegrationHub, *_nethttp.Response, error)

CreateIntegrationHub Create Integration Hub ### Create a new Integration Hub. This API is rate limited to prevent it from being used for SSRF attacks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Integration Hub
  • @param optional nil or *CreateIntegrationHubOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return IntegrationHub

func (*IntegrationApiService) DeleteIntegrationHub 

func (a *IntegrationApiService) DeleteIntegrationHub(ctx _context.Context, integrationHubId int64) (string, *_nethttp.Response, error)

DeleteIntegrationHub Delete Integration Hub ### Delete a Integration Hub.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationHubId Id of integration_hub

@return string

func (*IntegrationApiService) FetchIntegrationForm 

func (a *IntegrationApiService) FetchIntegrationForm(ctx _context.Context, integrationId int64) (DataActionForm, *_nethttp.Response, error)

FetchIntegrationForm Fetch Remote Integration Form Returns the Integration form for presentation to the user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationId Id of integration

@return DataActionForm

func (*IntegrationApiService) Integration 

func (a *IntegrationApiService) Integration(ctx _context.Context, integrationId int64, localVarOptionals *IntegrationOpts) (Integration, *_nethttp.Response, error)

Integration Get Integration ### Get information about a Integration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationId Id of integration
  • @param optional nil or *IntegrationOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Integration

func (*IntegrationApiService) IntegrationHub 

func (a *IntegrationApiService) IntegrationHub(ctx _context.Context, integrationHubId int64, localVarOptionals *IntegrationHubOpts) (IntegrationHub, *_nethttp.Response, error)

IntegrationHub Get Integration Hub ### Get information about a Integration Hub.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationHubId Id of Integration Hub
  • @param optional nil or *IntegrationHubOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return IntegrationHub

func (*IntegrationApiService) TestIntegration 

func (a *IntegrationApiService) TestIntegration(ctx _context.Context, integrationId int64) (IntegrationTestResult, *_nethttp.Response, error)

TestIntegration Test integration Tests the integration to make sure all the settings are working.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationId Id of integration

@return IntegrationTestResult

func (*IntegrationApiService) UpdateIntegration 

func (a *IntegrationApiService) UpdateIntegration(ctx _context.Context, integrationId int64, body Integration, localVarOptionals *UpdateIntegrationOpts) (Integration, *_nethttp.Response, error)

UpdateIntegration Update Integration ### Update parameters on a Integration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationId Id of integration
  • @param body Integration
  • @param optional nil or *UpdateIntegrationOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Integration

func (*IntegrationApiService) UpdateIntegrationHub 

func (a *IntegrationApiService) UpdateIntegrationHub(ctx _context.Context, integrationHubId int64, body IntegrationHub, localVarOptionals *UpdateIntegrationHubOpts) (IntegrationHub, *_nethttp.Response, error)

UpdateIntegrationHub Update Integration Hub ### Update a Integration Hub definition. This API is rate limited to prevent it from being used for SSRF attacks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param integrationHubId Id of Integration Hub
  • @param body Integration Hub
  • @param optional nil or *UpdateIntegrationHubOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return IntegrationHub

type IntegrationHub 

type IntegrationHub struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// ID of the hub.
	Id int64 `json:"id,omitempty"`
	// URL of the hub.
	Url string `json:"url,omitempty"`
	// Label of the hub.
	Label string `json:"label,omitempty"`
	// Whether this hub is a first-party integration hub operated by Looker.
	Official bool `json:"official,omitempty"`
	// An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.
	FetchErrorMessage string `json:"fetch_error_message,omitempty"`
	// (Write-Only) An authorization key that will be sent to the integration hub on every request.
	AuthorizationToken string `json:"authorization_token,omitempty"`
	// Whether the authorization_token is set for the hub.
	HasAuthorizationToken bool `json:"has_authorization_token,omitempty"`
	// Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.
	LegalAgreementSigned bool `json:"legal_agreement_signed,omitempty"`
	// Whether the legal terms for the integration hub are required before use.
	LegalAgreementRequired bool `json:"legal_agreement_required,omitempty"`
	// The legal agreement text for this integration hub.
	LegalAgreementText string `json:"legal_agreement_text,omitempty"`
}

IntegrationHub struct for IntegrationHub

type IntegrationHubOpts 

type IntegrationHubOpts struct {
	Fields optional.String
}

IntegrationHubOpts Optional parameters for the method 'IntegrationHub'

type IntegrationOpts 

type IntegrationOpts struct {
	Fields optional.String
}

IntegrationOpts Optional parameters for the method 'Integration'

type IntegrationParam 

type IntegrationParam struct {
	// Name of the parameter.
	Name string `json:"name,omitempty"`
	// Label of the parameter.
	Label string `json:"label,omitempty"`
	// Short description of the parameter.
	Description string `json:"description,omitempty"`
	// Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.
	Required bool `json:"required,omitempty"`
	// Whether the parameter has a value set.
	HasValue bool `json:"has_value,omitempty"`
	// The current value of the parameter. Always null if the value is sensitive. When writing, null values will be ignored. Set the value to an empty string to clear it.
	Value string `json:"value,omitempty"`
	// When present, the param's value comes from this user attribute instead of the 'value' parameter. Set to null to use the 'value'.
	UserAttributeName string `json:"user_attribute_name,omitempty"`
	// Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.
	Sensitive bool `json:"sensitive,omitempty"`
	// When true, this parameter must be assigned to a user attribute in the admin panel (instead of a constant value), and that value may be updated by the user as part of the integration flow.
	PerUser bool `json:"per_user,omitempty"`
	// When present, the param represents the oauth url the user will be taken to.
	DelegateOauthUrl string `json:"delegate_oauth_url,omitempty"`
}

IntegrationParam struct for IntegrationParam

type IntegrationRequiredField 

type IntegrationRequiredField struct {
	// Matches a field that has this tag.
	Tag string `json:"tag,omitempty"`
	// If present, supercedes 'tag' and matches a field that has any of the provided tags.
	AnyTag []string `json:"any_tag,omitempty"`
	// If present, supercedes 'tag' and matches a field that has all of the provided tags.
	AllTags []string `json:"all_tags,omitempty"`
}

IntegrationRequiredField struct for IntegrationRequiredField

type IntegrationTestResult 

type IntegrationTestResult struct {
	// Whether or not the test was successful
	Success bool `json:"success,omitempty"`
	// A message representing the results of the test.
	Message string `json:"message,omitempty"`
}

IntegrationTestResult struct for IntegrationTestResult

type InternalHelpResources 

type InternalHelpResources struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// If true and internal help resources content is not blank then the link for internal help resources will be shown in the help menu and the content displayed within Looker
	Enabled bool `json:"enabled,omitempty"`
}

InternalHelpResources struct for InternalHelpResources

type InternalHelpResourcesContent 

type InternalHelpResourcesContent struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Text to display in the help menu item which will display the internal help resources
	OrganizationName string `json:"organization_name,omitempty"`
	// Content to be displayed in the internal help resources page/modal
	MarkdownContent string `json:"markdown_content,omitempty"`
}

InternalHelpResourcesContent struct for InternalHelpResourcesContent

type LdapConfig 

type LdapConfig struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Allow alternate email-based login via '/login/email' for admins and for specified users with the 'login_special_email' permission. This option is useful as a fallback during ldap setup, if ldap config problems occur later, or if you need to support some users who are not in your ldap directory. Looker email/password logins are always disabled for regular users when ldap is enabled.
	AlternateEmailLoginAllowed bool `json:"alternate_email_login_allowed,omitempty"`
	// (Write-Only)  Password for the LDAP account used to access the LDAP server
	AuthPassword string `json:"auth_password,omitempty"`
	// Users will not be allowed to login at all unless a role for them is found in LDAP if set to true
	AuthRequiresRole bool `json:"auth_requires_role,omitempty"`
	// Distinguished name of LDAP account used to access the LDAP server
	AuthUsername string `json:"auth_username,omitempty"`
	// LDAP server hostname
	ConnectionHost string `json:"connection_host,omitempty"`
	// LDAP host port
	ConnectionPort string `json:"connection_port,omitempty"`
	// Use Transport Layer Security
	ConnectionTls bool `json:"connection_tls,omitempty"`
	// Do not verify peer when using TLS
	ConnectionTlsNoVerify bool `json:"connection_tls_no_verify,omitempty"`
	// (Write-Only)  Array of ids of groups that will be applied to new users the first time they login via LDAP
	DefaultNewUserGroupIds []int64 `json:"default_new_user_group_ids,omitempty"`
	// (Read-only) Groups that will be applied to new users the first time they login via LDAP
	DefaultNewUserGroups []Group `json:"default_new_user_groups,omitempty"`
	// (Write-Only)  Array of ids of roles that will be applied to new users the first time they login via LDAP
	DefaultNewUserRoleIds []int64 `json:"default_new_user_role_ids,omitempty"`
	// (Read-only) Roles that will be applied to new users the first time they login via LDAP
	DefaultNewUserRoles []Role `json:"default_new_user_roles,omitempty"`
	// Enable/Disable LDAP authentication for the server
	Enabled bool `json:"enabled,omitempty"`
	// Don't attempt to do LDAP search result paging (RFC 2696) even if the LDAP server claims to support it.
	ForceNoPage bool `json:"force_no_page,omitempty"`
	// (Read-only) Array of mappings between LDAP Groups and Looker Roles
	Groups []LdapGroupRead `json:"groups,omitempty"`
	// Base dn for finding groups in LDAP searches
	GroupsBaseDn string `json:"groups_base_dn,omitempty"`
	// Identifier for a strategy for how Looker will search for groups in the LDAP server
	GroupsFinderType string `json:"groups_finder_type,omitempty"`
	// LDAP Group attribute that signifies the members of the groups. Most commonly 'member'
	GroupsMemberAttribute string `json:"groups_member_attribute,omitempty"`
	// Optional comma-separated list of supported LDAP objectclass for groups when doing groups searches
	GroupsObjectclasses string `json:"groups_objectclasses,omitempty"`
	// LDAP Group attribute that signifies the user in a group. Most commonly 'dn'
	GroupsUserAttribute string `json:"groups_user_attribute,omitempty"`
	// (Read/Write) Array of mappings between LDAP Groups and arrays of Looker Role ids
	GroupsWithRoleIds []LdapGroupWrite `json:"groups_with_role_ids,omitempty"`
	// (Read-only) Has the password been set for the LDAP account used to access the LDAP server
	HasAuthPassword bool `json:"has_auth_password,omitempty"`
	// Merge first-time ldap login to existing user account by email addresses. When a user logs in for the first time via ldap this option will connect this user into their existing account by finding the account with a matching email address. Otherwise a new user account will be created for the user.
	MergeNewUsersByEmail bool `json:"merge_new_users_by_email,omitempty"`
	// When this config was last modified
	ModifiedAt string `json:"modified_at,omitempty"`
	// User id of user who last modified this config
	ModifiedBy string `json:"modified_by,omitempty"`
	// Set user roles in Looker based on groups from LDAP
	SetRolesFromGroups bool `json:"set_roles_from_groups,omitempty"`
	// (Write-Only)  Test LDAP user password. For ldap tests only.
	TestLdapPassword string `json:"test_ldap_password,omitempty"`
	// (Write-Only)  Test LDAP user login id. For ldap tests only.
	TestLdapUser string `json:"test_ldap_user,omitempty"`
	// Name of user record attributes used to indicate email address field
	UserAttributeMapEmail string `json:"user_attribute_map_email,omitempty"`
	// Name of user record attributes used to indicate first name
	UserAttributeMapFirstName string `json:"user_attribute_map_first_name,omitempty"`
	// Name of user record attributes used to indicate last name
	UserAttributeMapLastName string `json:"user_attribute_map_last_name,omitempty"`
	// Name of user record attributes used to indicate unique record id
	UserAttributeMapLdapId string `json:"user_attribute_map_ldap_id,omitempty"`
	// (Read-only) Array of mappings between LDAP User Attributes and Looker User Attributes
	UserAttributes []LdapUserAttributeRead `json:"user_attributes,omitempty"`
	// (Read/Write) Array of mappings between LDAP User Attributes and arrays of Looker User Attribute ids
	UserAttributesWithIds []LdapUserAttributeWrite `json:"user_attributes_with_ids,omitempty"`
	// Distinguished name of LDAP node used as the base for user searches
	UserBindBaseDn string `json:"user_bind_base_dn,omitempty"`
	// (Optional) Custom RFC-2254 filter clause for use in finding user during login. Combined via 'and' with the other generated filter clauses.
	UserCustomFilter string `json:"user_custom_filter,omitempty"`
	// Name(s) of user record attributes used for matching user login id (comma separated list)
	UserIdAttributeNames string `json:"user_id_attribute_names,omitempty"`
	// (Optional) Name of user record objectclass used for finding user during login id
	UserObjectclass string `json:"user_objectclass,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

LdapConfig struct for LdapConfig

type LdapConfigTestIssue 

type LdapConfigTestIssue struct {
	// Severity of the issue. Error or Warning
	Severity string `json:"severity,omitempty"`
	// Message describing the issue
	Message string `json:"message,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

LdapConfigTestIssue struct for LdapConfigTestIssue

type LdapConfigTestResult 

type LdapConfigTestResult struct {
	// Additional details for error cases
	Details string `json:"details,omitempty"`
	// Array of issues/considerations about the result
	Issues []LdapConfigTestIssue `json:"issues,omitempty"`
	// Short human readable test about the result
	Message string `json:"message,omitempty"`
	// Test status code: always 'success' or 'error'
	Status string `json:"status,omitempty"`
	// A more detailed trace of incremental results during auth tests
	Trace string   `json:"trace,omitempty"`
	User  LdapUser `json:"user,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapConfigTestResult struct for LdapConfigTestResult

type LdapGroupRead 

type LdapGroupRead struct {
	// Name of group in LDAP
	Name string `json:"name,omitempty"`
	// Looker Roles
	Roles []Role `json:"roles,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapGroupRead struct for LdapGroupRead

type LdapGroupWrite 

type LdapGroupWrite struct {
	// Name of group in LDAP
	Name string `json:"name,omitempty"`
	// Looker Role Ids
	RoleIds []int64 `json:"role_ids,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapGroupWrite struct for LdapGroupWrite

type LdapUser 

type LdapUser struct {
	// Array of user's email addresses and aliases for use in migration
	AllEmails []string `json:"all_emails,omitempty"`
	// Dictionary of user's attributes (name/value)
	Attributes map[string]string `json:"attributes,omitempty"`
	// Primary email address
	Email string `json:"email,omitempty"`
	// First name
	FirstName string `json:"first_name,omitempty"`
	// Array of user's groups (group names only)
	Groups []string `json:"groups,omitempty"`
	// Last Name
	LastName string `json:"last_name,omitempty"`
	// LDAP's distinguished name for the user record
	LdapDn string `json:"ldap_dn,omitempty"`
	// LDAP's Unique ID for the user
	LdapId string `json:"ldap_id,omitempty"`
	// Array of user's roles (role names only)
	Roles []string `json:"roles,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapUser struct for LdapUser

type LdapUserAttributeRead 

type LdapUserAttributeRead struct {
	// Name of User Attribute in LDAP
	Name string `json:"name,omitempty"`
	// Required to be in LDAP assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attributes
	UserAttributes []UserAttribute `json:"user_attributes,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapUserAttributeRead struct for LdapUserAttributeRead

type LdapUserAttributeWrite 

type LdapUserAttributeWrite struct {
	// Name of User Attribute in LDAP
	Name string `json:"name,omitempty"`
	// Required to be in LDAP assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attribute Ids
	UserAttributeIds []int64 `json:"user_attribute_ids,omitempty"`
	// Link to ldap config
	Url string `json:"url,omitempty"`
}

LdapUserAttributeWrite struct for LdapUserAttributeWrite

type LegacyFeature 

type LegacyFeature struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Name
	Name string `json:"name,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Whether this feature has been enabled by a user
	EnabledLocally bool `json:"enabled_locally,omitempty"`
	// Whether this feature is currently enabled
	Enabled bool `json:"enabled,omitempty"`
	// Looker version where this feature became a legacy feature
	DisallowedAsOfVersion string `json:"disallowed_as_of_version,omitempty"`
	// Looker version where this feature will be automatically disabled
	DisableOnUpgradeToVersion string `json:"disable_on_upgrade_to_version,omitempty"`
	// Future Looker version where this feature will be removed
	EndOfLifeVersion string `json:"end_of_life_version,omitempty"`
	// URL for documentation about this feature
	DocumentationUrl string `json:"documentation_url,omitempty"`
	// Approximate date that this feature will be automatically disabled.
	ApproximateDisableDate time.Time `json:"approximate_disable_date,omitempty"`
	// Approximate date that this feature will be removed.
	ApproximateEndOfLifeDate time.Time `json:"approximate_end_of_life_date,omitempty"`
	// Whether this legacy feature may have been automatically disabled when upgrading to the current version.
	HasDisabledOnUpgrade bool `json:"has_disabled_on_upgrade,omitempty"`
}

LegacyFeature struct for LegacyFeature

type Locale 

type Locale struct {
	// Code for Locale
	Code string `json:"code,omitempty"`
	// Name of Locale in its own language
	NativeName string `json:"native_name,omitempty"`
	// Name of Locale in English
	EnglishName string `json:"english_name,omitempty"`
}

Locale struct for Locale

type LocalizationSettings 

type LocalizationSettings struct {
	// Default locale for localization
	DefaultLocale string `json:"default_locale,omitempty"`
	// Localization level - strict or permissive
	LocalizationLevel string `json:"localization_level,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

LocalizationSettings struct for LocalizationSettings

type LoginOpts 

type LoginOpts struct {
	ClientId     optional.String
	ClientSecret optional.String
}

LoginOpts Optional parameters for the method 'Login'

type Look 

type Look struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Look Title
	Title string `json:"title,omitempty"`
	// Content Favorite Id
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Time that the Look was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Whether or not a look is 'soft' deleted.
	Deleted bool `json:"deleted,omitempty"`
	// Time that the Look was deleted.
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// Id of User that deleted the look.
	DeleterId int64 `json:"deleter_id,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Embed Url
	EmbedUrl string `json:"embed_url,omitempty"`
	// Excel File Url
	ExcelFileUrl string `json:"excel_file_url,omitempty"`
	// Number of times favorited
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Google Spreadsheet Formula
	GoogleSpreadsheetFormula string `json:"google_spreadsheet_formula,omitempty"`
	// Image Embed Url
	ImageEmbedUrl string `json:"image_embed_url,omitempty"`
	// auto-run query when Look viewed
	IsRunOnLoad bool `json:"is_run_on_load,omitempty"`
	// Time that the Look was last accessed by any user
	LastAccessedAt time.Time `json:"last_accessed_at,omitempty"`
	// Id of User that last updated the look.
	LastUpdaterId int64 `json:"last_updater_id,omitempty"`
	// Time last viewed in the Looker web UI
	LastViewedAt time.Time `json:"last_viewed_at,omitempty"`
	Model        LookModel `json:"model,omitempty"`
	// Is Public
	Public bool `json:"public,omitempty"`
	// Public Slug
	PublicSlug string `json:"public_slug,omitempty"`
	// Public Url
	PublicUrl string `json:"public_url,omitempty"`
	// Query Id
	QueryId int64 `json:"query_id,omitempty"`
	// Short Url
	ShortUrl string     `json:"short_url,omitempty"`
	Space    SpaceBase  `json:"space,omitempty"`
	Folder   FolderBase `json:"folder,omitempty"`
	// Space Id
	SpaceId string `json:"space_id,omitempty"`
	// Folder Id
	FolderId string `json:"folder_id,omitempty"`
	// Time that the Look was updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// User Id
	UserId int64 `json:"user_id,omitempty"`
	// Number of times viewed in the Looker web UI
	ViewCount int64      `json:"view_count,omitempty"`
	User      UserIdOnly `json:"user,omitempty"`
}

Look struct for Look

type LookApiService 

type LookApiService service

LookApiService LookApi service

func (*LookApiService) AllLooks 

func (a *LookApiService) AllLooks(ctx _context.Context, localVarOptionals *AllLooksOpts) ([]Look, *_nethttp.Response, error)

AllLooks Get All Looks ### Get information about all active Looks Returns an array of **abbreviated Look objects** describing all the looks that the caller has access to. Soft-deleted Looks are **not** included. Get the **full details** of a specific look by id with [look(id)](#!/Look/look) Find **soft-deleted looks** with [search_looks()](#!/Look/search_looks)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllLooksOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Look

func (*LookApiService) CreateLook 

func (a *LookApiService) CreateLook(ctx _context.Context, body LookWithQuery, localVarOptionals *CreateLookOpts) (LookWithQuery, *_nethttp.Response, error)

CreateLook Create Look ### Create a Look To create a look to display query data, first create the query with [create_query()](#!/Query/create_query) then assign the query&#39;s id to the &#x60;query_id&#x60; property in the call to &#x60;create_look()&#x60;. To place the look into a particular space, assign the space&#39;s id to the &#x60;space_id&#x60; property in the call to &#x60;create_look()&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Look
  • @param optional nil or *CreateLookOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return LookWithQuery

func (*LookApiService) DeleteLook 

func (a *LookApiService) DeleteLook(ctx _context.Context, lookId int64) (string, *_nethttp.Response, error)

DeleteLook Delete Look ### Permanently Delete a Look This operation **permanently** removes a look from the Looker database. NOTE: There is no \&quot;undo\&quot; for this kind of delete. For information about soft-delete (which can be undone) see [update_look()](#!/Look/update_look).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Id of look

@return string

func (*LookApiService) Look 

func (a *LookApiService) Look(ctx _context.Context, lookId int64, localVarOptionals *LookOpts) (LookWithQuery, *_nethttp.Response, error)

Look Get Look ### Get a Look. Returns detailed information about a Look and its associated Query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Id of look
  • @param optional nil or *LookOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return LookWithQuery

func (*LookApiService) RunLook 

func (a *LookApiService) RunLook(ctx _context.Context, lookId int64, resultFormat string, localVarOptionals *RunLookOpts) (string, *_nethttp.Response, error)

RunLook Run Look ### Run a Look Runs a given look&#39;s query and returns the results in the requested format. Supported formats: | result_format | Description | :-----------: | :--- | | json | Plain json | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | md | Simple markdown | xlsx | MS Excel spreadsheet | sql | Returns the generated SQL rather than running the query | png | A PNG image of the visualization of the query | jpg | A JPG image of the visualization of the query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Id of look
  • @param resultFormat Format of result
  • @param optional nil or *RunLookOpts - Optional Parameters:
  • @param "Limit" (optional.Int64) - Row limit (may override the limit in the saved query).
  • @param "ApplyFormatting" (optional.Bool) - Apply model-specified formatting to each result.
  • @param "ApplyVis" (optional.Bool) - Apply visualization options to results.
  • @param "Cache" (optional.Bool) - Get results from cache if available.
  • @param "ImageWidth" (optional.Int64) - Render width for image formats.
  • @param "ImageHeight" (optional.Int64) - Render height for image formats.
  • @param "GenerateDrillLinks" (optional.Bool) - Generate drill links (only applicable to 'json_detail' format.
  • @param "ForceProduction" (optional.Bool) - Force use of production models even if the user is in development mode.
  • @param "CacheOnly" (optional.Bool) - Retrieve any results from cache even if the results have expired.
  • @param "PathPrefix" (optional.String) - Prefix to use for drill links (url encoded).
  • @param "RebuildPdts" (optional.Bool) - Rebuild PDTS used in query.
  • @param "ServerTableCalcs" (optional.Bool) - Perform table calculations on query results

@return string

func (*LookApiService) SearchLooks 

func (a *LookApiService) SearchLooks(ctx _context.Context, localVarOptionals *SearchLooksOpts) ([]Look, *_nethttp.Response, error)

SearchLooks Search Looks ### Search Looks Returns an **array of Look objects** that match the specified search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values. Get a **single look** by id with [look(id)](#!/Look/look)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchLooksOpts - Optional Parameters:
  • @param "Title" (optional.String) - Match Look title.
  • @param "Description" (optional.String) - Match Look description.
  • @param "ContentFavoriteId" (optional.Int64) - Select looks with a particular content favorite id
  • @param "SpaceId" (optional.String) - Select looks in a particular space.
  • @param "UserId" (optional.String) - Select looks created by a particular user.
  • @param "ViewCount" (optional.String) - Select looks with particular view_count value
  • @param "Deleted" (optional.Bool) - Select soft-deleted looks
  • @param "QueryId" (optional.Int64) - Select looks that reference a particular query by query_id
  • @param "Curate" (optional.Bool) - Exclude items that exist only in personal spaces other than the users
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Limit" (optional.Int64) - Number of results to return. (used with offset and takes priority over page and per_page)
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
  • @param "Sorts" (optional.String) - One or more fields to sort results by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :description, :updated_at, :last_updater_id, :view_count, :favorite_count, :content_favorite_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at, :query_id]
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Look

func (*LookApiService) UpdateLook 

func (a *LookApiService) UpdateLook(ctx _context.Context, lookId int64, body LookWithQuery, localVarOptionals *UpdateLookOpts) (LookWithQuery, *_nethttp.Response, error)

UpdateLook Update Look ### Modify a Look Use this function to modify parts of a look. Property values given in a call to &#x60;update_look&#x60; are applied to the existing look, so there&#39;s no need to include properties whose values are not changing. It&#39;s best to specify only the properties you want to change and leave everything else out of your &#x60;update_look&#x60; call. **Look properties marked &#39;read-only&#39; will be ignored.** When a user deletes a look in the Looker UI, the look data remains in the database but is marked with a deleted flag (\&quot;soft-deleted\&quot;). Soft-deleted looks can be undeleted (by an admin) if the delete was in error. To soft-delete a look via the API, use [update_look()](#!/Look/update_look) to change the look&#39;s &#x60;deleted&#x60; property to &#x60;true&#x60;. You can undelete a look by calling &#x60;update_look&#x60; to change the look&#39;s &#x60;deleted&#x60; property to &#x60;false&#x60;. Soft-deleted looks are excluded from the results of [all_looks()](#!/Look/all_looks) and [search_looks()](#!/Look/search_looks), so they essentially disappear from view even though they still reside in the db. In API 3.1 and later, you can pass &#x60;deleted: true&#x60; as a parameter to [search_looks()](#!/3.1/Look/search_looks) to list soft-deleted looks. NOTE: [delete_look()](#!/Look/delete_look) performs a \&quot;hard delete\&quot; - the look data is removed from the Looker database and destroyed. There is no \&quot;undo\&quot; for &#x60;delete_look()&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Id of look
  • @param body Look
  • @param optional nil or *UpdateLookOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return LookWithQuery

type LookBasic 

type LookBasic struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Look Title
	Title string `json:"title,omitempty"`
}

LookBasic struct for LookBasic

type LookModel 

type LookModel struct {
	// Model Id
	Id string `json:"id,omitempty"`
	// Model Label
	Label string `json:"label,omitempty"`
}

LookModel struct for LookModel

type LookOpts 

type LookOpts struct {
	Fields optional.String
}

LookOpts Optional parameters for the method 'Look'

type LookWithDashboards 

type LookWithDashboards struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Look Title
	Title string `json:"title,omitempty"`
	// Content Favorite Id
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Time that the Look was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Whether or not a look is 'soft' deleted.
	Deleted bool `json:"deleted,omitempty"`
	// Time that the Look was deleted.
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// Id of User that deleted the look.
	DeleterId int64 `json:"deleter_id,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Embed Url
	EmbedUrl string `json:"embed_url,omitempty"`
	// Excel File Url
	ExcelFileUrl string `json:"excel_file_url,omitempty"`
	// Number of times favorited
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Google Spreadsheet Formula
	GoogleSpreadsheetFormula string `json:"google_spreadsheet_formula,omitempty"`
	// Image Embed Url
	ImageEmbedUrl string `json:"image_embed_url,omitempty"`
	// auto-run query when Look viewed
	IsRunOnLoad bool `json:"is_run_on_load,omitempty"`
	// Time that the Look was last accessed by any user
	LastAccessedAt time.Time `json:"last_accessed_at,omitempty"`
	// Id of User that last updated the look.
	LastUpdaterId int64 `json:"last_updater_id,omitempty"`
	// Time last viewed in the Looker web UI
	LastViewedAt time.Time `json:"last_viewed_at,omitempty"`
	Model        LookModel `json:"model,omitempty"`
	// Is Public
	Public bool `json:"public,omitempty"`
	// Public Slug
	PublicSlug string `json:"public_slug,omitempty"`
	// Public Url
	PublicUrl string `json:"public_url,omitempty"`
	// Query Id
	QueryId int64 `json:"query_id,omitempty"`
	// Short Url
	ShortUrl string     `json:"short_url,omitempty"`
	Space    SpaceBase  `json:"space,omitempty"`
	Folder   FolderBase `json:"folder,omitempty"`
	// Space Id
	SpaceId string `json:"space_id,omitempty"`
	// Folder Id
	FolderId string `json:"folder_id,omitempty"`
	// Time that the Look was updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// User Id
	UserId int64 `json:"user_id,omitempty"`
	// Number of times viewed in the Looker web UI
	ViewCount int64      `json:"view_count,omitempty"`
	User      UserIdOnly `json:"user,omitempty"`
	// Dashboards
	Dashboards []DashboardBase `json:"dashboards,omitempty"`
}

LookWithDashboards struct for LookWithDashboards

type LookWithQuery 

type LookWithQuery struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Look Title
	Title string `json:"title,omitempty"`
	// Content Favorite Id
	ContentFavoriteId int64 `json:"content_favorite_id,omitempty"`
	// Time that the Look was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Whether or not a look is 'soft' deleted.
	Deleted bool `json:"deleted,omitempty"`
	// Time that the Look was deleted.
	DeletedAt time.Time `json:"deleted_at,omitempty"`
	// Id of User that deleted the look.
	DeleterId int64 `json:"deleter_id,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Embed Url
	EmbedUrl string `json:"embed_url,omitempty"`
	// Excel File Url
	ExcelFileUrl string `json:"excel_file_url,omitempty"`
	// Number of times favorited
	FavoriteCount int64 `json:"favorite_count,omitempty"`
	// Google Spreadsheet Formula
	GoogleSpreadsheetFormula string `json:"google_spreadsheet_formula,omitempty"`
	// Image Embed Url
	ImageEmbedUrl string `json:"image_embed_url,omitempty"`
	// auto-run query when Look viewed
	IsRunOnLoad bool `json:"is_run_on_load,omitempty"`
	// Time that the Look was last accessed by any user
	LastAccessedAt time.Time `json:"last_accessed_at,omitempty"`
	// Id of User that last updated the look.
	LastUpdaterId int64 `json:"last_updater_id,omitempty"`
	// Time last viewed in the Looker web UI
	LastViewedAt time.Time `json:"last_viewed_at,omitempty"`
	Model        LookModel `json:"model,omitempty"`
	// Is Public
	Public bool `json:"public,omitempty"`
	// Public Slug
	PublicSlug string `json:"public_slug,omitempty"`
	// Public Url
	PublicUrl string `json:"public_url,omitempty"`
	// Query Id
	QueryId int64 `json:"query_id,omitempty"`
	// Short Url
	ShortUrl string     `json:"short_url,omitempty"`
	Space    SpaceBase  `json:"space,omitempty"`
	Folder   FolderBase `json:"folder,omitempty"`
	// Space Id
	SpaceId string `json:"space_id,omitempty"`
	// Folder Id
	FolderId string `json:"folder_id,omitempty"`
	// Time that the Look was updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// User Id
	UserId int64 `json:"user_id,omitempty"`
	// Number of times viewed in the Looker web UI
	ViewCount int64      `json:"view_count,omitempty"`
	User      UserIdOnly `json:"user,omitempty"`
	Query     Query      `json:"query,omitempty"`
	// Url
	Url string `json:"url,omitempty"`
}

LookWithQuery struct for LookWithQuery

type LookmlModel 

type LookmlModel struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Array of names of connections this model is allowed to use
	AllowedDbConnectionNames []string `json:"allowed_db_connection_names,omitempty"`
	// Array of explores (if has_content)
	Explores []LookmlModelNavExplore `json:"explores,omitempty"`
	// Does this model declaration have have lookml content?
	HasContent bool `json:"has_content,omitempty"`
	// UI-friendly name for this model
	Label string `json:"label,omitempty"`
	// Name of the model. Also used as the unique identifier
	Name string `json:"name,omitempty"`
	// Name of project containing the model
	ProjectName string `json:"project_name,omitempty"`
	// Is this model allowed to use all current and future connections
	UnlimitedDbConnections bool `json:"unlimited_db_connections,omitempty"`
}

LookmlModel struct for LookmlModel

type LookmlModelApiService 

type LookmlModelApiService service

LookmlModelApiService LookmlModelApi service

func (*LookmlModelApiService) AllLookmlModels 

func (a *LookmlModelApiService) AllLookmlModels(ctx _context.Context, localVarOptionals *AllLookmlModelsOpts) ([]LookmlModel, *_nethttp.Response, error)

AllLookmlModels Get All LookML Models ### Get information about all lookml models.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllLookmlModelsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []LookmlModel

func (*LookmlModelApiService) CreateLookmlModel 

func (a *LookmlModelApiService) CreateLookmlModel(ctx _context.Context, body LookmlModel) (LookmlModel, *_nethttp.Response, error)

CreateLookmlModel Create LookML Model ### Create a lookml model using the specified configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body LookML Model

@return LookmlModel

func (*LookmlModelApiService) DeleteLookmlModel 

func (a *LookmlModelApiService) DeleteLookmlModel(ctx _context.Context, lookmlModelName string) (string, *_nethttp.Response, error)

DeleteLookmlModel Delete LookML Model ### Delete a lookml model.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlModelName Name of lookml model.

@return string

func (*LookmlModelApiService) LookmlModel 

func (a *LookmlModelApiService) LookmlModel(ctx _context.Context, lookmlModelName string, localVarOptionals *LookmlModelOpts) (LookmlModel, *_nethttp.Response, error)

LookmlModel Get LookML Model ### Get information about a lookml model.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlModelName Name of lookml model.
  • @param optional nil or *LookmlModelOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return LookmlModel

func (*LookmlModelApiService) LookmlModelExplore 

func (a *LookmlModelApiService) LookmlModelExplore(ctx _context.Context, lookmlModelName string, exploreName string, localVarOptionals *LookmlModelExploreOpts) (LookmlModelExplore, *_nethttp.Response, error)

LookmlModelExplore Get LookML Model Explore ### Get information about a lookml model explore.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlModelName Name of lookml model.
  • @param exploreName Name of explore.
  • @param optional nil or *LookmlModelExploreOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return LookmlModelExplore

func (*LookmlModelApiService) UpdateLookmlModel 

func (a *LookmlModelApiService) UpdateLookmlModel(ctx _context.Context, lookmlModelName string, body LookmlModel) (LookmlModel, *_nethttp.Response, error)

UpdateLookmlModel Update LookML Model ### Update a lookml model using the specified configuration.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlModelName Name of lookml model.
  • @param body LookML Model

@return LookmlModel

type LookmlModelExplore 

type LookmlModelExplore struct {
	// Fully qualified name model plus explore name
	Id string `json:"id,omitempty"`
	// Explore name
	Name string `json:"name,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// Label
	Label string `json:"label,omitempty"`
	// Scopes
	Scopes []string `json:"scopes,omitempty"`
	// Can Total
	CanTotal bool `json:"can_total,omitempty"`
	// Can Save
	CanSave bool `json:"can_save,omitempty"`
	// Can Explain
	CanExplain bool `json:"can_explain,omitempty"`
	// Can pivot in the DB
	CanPivotInDb bool `json:"can_pivot_in_db,omitempty"`
	// Can use subtotals
	CanSubtotal bool `json:"can_subtotal,omitempty"`
	// Has timezone support
	HasTimezoneSupport bool `json:"has_timezone_support,omitempty"`
	// Cost estimates supported
	SupportsCostEstimate bool `json:"supports_cost_estimate,omitempty"`
	// Connection name
	ConnectionName string `json:"connection_name,omitempty"`
	// How nulls are sorted, possible values are \"low\", \"high\", \"first\" and \"last\"
	NullSortTreatment string `json:"null_sort_treatment,omitempty"`
	// List of model source files
	Files []string `json:"files,omitempty"`
	// Primary source_file file
	SourceFile string `json:"source_file,omitempty"`
	// Name of project
	ProjectName string `json:"project_name,omitempty"`
	// Name of model
	ModelName string `json:"model_name,omitempty"`
	// Name of view
	ViewName string `json:"view_name,omitempty"`
	// Is hidden
	Hidden bool `json:"hidden,omitempty"`
	// A sql_table_name expression that defines what sql table the view/explore maps onto. Example: \"prod_orders2 AS orders\" in a view named orders.
	SqlTableName string `json:"sql_table_name,omitempty"`
	// (DEPRECATED) Array of access filter field names
	AccessFilterFields []string `json:"access_filter_fields,omitempty"`
	// Access filters
	AccessFilters []LookmlModelExploreAccessFilter `json:"access_filters,omitempty"`
	// Aliases
	Aliases []LookmlModelExploreAlias `json:"aliases,omitempty"`
	// Always filter
	AlwaysFilter []LookmlModelExploreAlwaysFilter `json:"always_filter,omitempty"`
	// Conditionally filter
	ConditionallyFilter []LookmlModelExploreConditionallyFilter `json:"conditionally_filter,omitempty"`
	// Array of index fields
	IndexFields []string `json:"index_fields,omitempty"`
	// Sets
	Sets []LookmlModelExploreSet `json:"sets,omitempty"`
	// An array of arbitrary string tags provided in the model for this explore.
	Tags []string `json:"tags,omitempty"`
	// Errors
	Errors []LookmlModelExploreError  `json:"errors,omitempty"`
	Fields LookmlModelExploreFieldset `json:"fields,omitempty"`
	// Views joined into this explore
	Joins []LookmlModelExploreJoins `json:"joins,omitempty"`
	// Label used to group explores in the navigation menus
	GroupLabel string `json:"group_label,omitempty"`
	// An array of items describing which custom measure types are supported for creating a custom measure 'baed_on' each possible dimension type.
	SupportedMeasureTypes []LookmlModelExploreSupportedMeasureType `json:"supported_measure_types,omitempty"`
}

LookmlModelExplore struct for LookmlModelExplore

type LookmlModelExploreAccessFilter 

type LookmlModelExploreAccessFilter struct {
	// Field to be filtered
	Field string `json:"field,omitempty"`
	// User attribute name
	UserAttribute string `json:"user_attribute,omitempty"`
}

LookmlModelExploreAccessFilter struct for LookmlModelExploreAccessFilter

type LookmlModelExploreAlias 

type LookmlModelExploreAlias struct {
	// Name
	Name string `json:"name,omitempty"`
	// Value
	Value string `json:"value,omitempty"`
}

LookmlModelExploreAlias struct for LookmlModelExploreAlias

type LookmlModelExploreAlwaysFilter 

type LookmlModelExploreAlwaysFilter struct {
	// Name
	Name string `json:"name,omitempty"`
	// Value
	Value string `json:"value,omitempty"`
}

LookmlModelExploreAlwaysFilter struct for LookmlModelExploreAlwaysFilter

type LookmlModelExploreConditionallyFilter 

type LookmlModelExploreConditionallyFilter struct {
	// Name
	Name string `json:"name,omitempty"`
	// Value
	Value string `json:"value,omitempty"`
}

LookmlModelExploreConditionallyFilter struct for LookmlModelExploreConditionallyFilter

type LookmlModelExploreError 

type LookmlModelExploreError struct {
	// Error Message
	Message string `json:"message,omitempty"`
	// Details
	Details string `json:"details,omitempty"`
	// Error source location
	ErrorPos string `json:"error_pos,omitempty"`
	// Is this a field error
	FieldError bool `json:"field_error,omitempty"`
}

LookmlModelExploreError struct for LookmlModelExploreError

type LookmlModelExploreField 

type LookmlModelExploreField struct {
	// The appropriate horizontal text alignment the values of this field shoud be displayed in. Valid values are: \"left\", \"right\".
	Align string `json:"align,omitempty"`
	// Whether it's possible to filter on this field.
	CanFilter bool `json:"can_filter,omitempty"`
	// Field category Valid values are: \"parameter\", \"filter\", \"measure\", \"dimension\".
	Category string `json:"category,omitempty"`
	// The default value that this field uses when filtering. Null if there is no default value.
	DefaultFilterValue string `json:"default_filter_value,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
	// An array enumerating all the possible values that this field can contain. When null, there is no limit to the set of possible values this field can contain.
	Enumerations []LookmlModelExploreFieldEnumeration `json:"enumerations,omitempty"`
	// An error message indicating a problem with the definition of this field. If there are no errors, this will be null.
	Error string `json:"error,omitempty"`
	// A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.
	FieldGroupLabel string `json:"field_group_label,omitempty"`
	// When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.
	FieldGroupVariant string `json:"field_group_variant,omitempty"`
	// The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: \"enumeration\", \"range\".
	FillStyle string `json:"fill_style,omitempty"`
	// An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.
	FiscalMonthOffset int64 `json:"fiscal_month_offset,omitempty"`
	// Whether this field has a set of allowed_values specified in LookML.
	HasAllowedValues bool `json:"has_allowed_values,omitempty"`
	// Whether this field should be hidden from the user interface.
	Hidden bool `json:"hidden,omitempty"`
	// Whether this field is a filter.
	IsFilter bool `json:"is_filter,omitempty"`
	// Whether this field represents a fiscal time value.
	IsFiscal bool `json:"is_fiscal,omitempty"`
	// Whether this field is of a type that represents a numeric value.
	IsNumeric bool `json:"is_numeric,omitempty"`
	// Whether this field is of a type that represents a time value.
	IsTimeframe bool `json:"is_timeframe,omitempty"`
	// Whether this field can be time filtered.
	CanTimeFilter bool                                `json:"can_time_filter,omitempty"`
	TimeInterval  LookmlModelExploreFieldTimeInterval `json:"time_interval,omitempty"`
	// Fully-qualified human-readable label of the field.
	Label string `json:"label,omitempty"`
	// The name of the parameter that will provide a parameterized label for this field, if available in the current context.
	LabelFromParameter string `json:"label_from_parameter,omitempty"`
	// The human-readable label of the field, without the view label.
	LabelShort string `json:"label_short,omitempty"`
	// A URL linking to the definition of this field in the LookML IDE.
	LookmlLink string                          `json:"lookml_link,omitempty"`
	MapLayer   LookmlModelExploreFieldMapLayer `json:"map_layer,omitempty"`
	// Whether this field is a measure.
	Measure bool `json:"measure,omitempty"`
	// Fully-qualified name of the field.
	Name string `json:"name,omitempty"`
	// If yes, the field will not be localized with the user attribute number_format. Defaults to no
	StrictValueFormat bool `json:"strict_value_format,omitempty"`
	// Whether this field is a parameter.
	Parameter bool `json:"parameter,omitempty"`
	// Whether this field can be removed from a query.
	Permanent bool `json:"permanent,omitempty"`
	// Whether or not the field represents a primary key.
	PrimaryKey bool `json:"primary_key,omitempty"`
	// The name of the project this field is defined in.
	ProjectName string `json:"project_name,omitempty"`
	// When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.
	RequiresRefreshOnSort bool `json:"requires_refresh_on_sort,omitempty"`
	// The LookML scope this field belongs to. The scope is typically the field's view.
	Scope string `json:"scope,omitempty"`
	// Whether this field can be sorted.
	Sortable bool `json:"sortable,omitempty"`
	// The path portion of source_file_path.
	SourceFile string `json:"source_file,omitempty"`
	// The fully-qualified path of the project file this field is defined in.
	SourceFilePath string `json:"source_file_path,omitempty"`
	// SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
	Sql string `json:"sql,omitempty"`
	// An array of conditions and values that make up a SQL Case expression, as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.
	SqlCase []LookmlModelExploreFieldSqlCase `json:"sql_case,omitempty"`
	// The name of the dimension to base suggest queries from.
	SuggestDimension string `json:"suggest_dimension,omitempty"`
	// The name of the explore to base suggest queries from.
	SuggestExplore string `json:"suggest_explore,omitempty"`
	// Whether or not suggestions are possible for this field.
	Suggestable bool `json:"suggestable,omitempty"`
	// If available, a list of suggestions for this field. For most fields, a suggest query is a more appropriate way to get an up-to-date list of suggestions. Or use enumerations to list all the possible values.
	Suggestions []string `json:"suggestions,omitempty"`
	// An array of arbitrary string tags provided in the model for this field.
	Tags []string `json:"tags,omitempty"`
	// The LookML type of the field.
	Type string `json:"type,omitempty"`
	// An array of user attribute types that are allowed to be used in filters on this field. Valid values are: \"advanced_filter_string\", \"advanced_filter_number\", \"advanced_filter_datetime\", \"string\", \"number\", \"datetime\", \"relative_url\", \"yesno\", \"zipcode\".
	UserAttributeFilterTypes []string `json:"user_attribute_filter_types,omitempty"`
	// If specified, the LookML value format string for formatting values of this field.
	ValueFormat string `json:"value_format,omitempty"`
	// The name of the view this field belongs to.
	View string `json:"view,omitempty"`
	// The human-readable label of the view the field belongs to.
	ViewLabel string `json:"view_label,omitempty"`
	// Whether this field was specified in \"dynamic_fields\" and is not part of the model.
	Dynamic bool `json:"dynamic,omitempty"`
	// The name of the starting day of the week. Valid values are: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\".
	WeekStartDay string `json:"week_start_day,omitempty"`
}

LookmlModelExploreField struct for LookmlModelExploreField

type LookmlModelExploreFieldEnumeration 

type LookmlModelExploreFieldEnumeration struct {
	// Label
	Label string `json:"label,omitempty"`
	// Value
	Value string `json:"value,omitempty"`
}

LookmlModelExploreFieldEnumeration struct for LookmlModelExploreFieldEnumeration

type LookmlModelExploreFieldMapLayer 

type LookmlModelExploreFieldMapLayer struct {
	// URL to the map layer resource.
	Url string `json:"url,omitempty"`
	// Name of the map layer, as defined in LookML.
	Name string `json:"name,omitempty"`
	// Specifies the name of the TopoJSON object that the map layer references. If not specified, use the first object..
	FeatureKey string `json:"feature_key,omitempty"`
	// Selects which property from the TopoJSON data to plot against. TopoJSON supports arbitrary metadata for each region. When null, the first matching property should be used.
	PropertyKey string `json:"property_key,omitempty"`
	// Which property from the TopoJSON data to use to label the region. When null, property_key should be used.
	PropertyLabelKey string `json:"property_label_key,omitempty"`
	// The preferred geographic projection of the map layer when displayed in a visualization that supports multiple geographic projections.
	Projection string `json:"projection,omitempty"`
	// Specifies the data format of the region information. Valid values are: \"topojson\", \"vector_tile_region\".
	Format string `json:"format,omitempty"`
	// Specifies the URL to a JSON file that defines the geographic extents of each region available in the map layer. This data is used to automatically center the map on the available data for visualization purposes. The JSON file must be a JSON object where the keys are the mapping value of the feature (as specified by property_key) and the values are arrays of four numbers representing the west longitude, south latitude, east longitude, and north latitude extents of the region. The object must include a key for every possible value of property_key.
	ExtentsJsonUrl string `json:"extents_json_url,omitempty"`
	// The minimum zoom level that the map layer may be displayed at, for visualizations that support zooming.
	MaxZoomLevel int64 `json:"max_zoom_level,omitempty"`
	// The maximum zoom level that the map layer may be displayed at, for visualizations that support zooming.
	MinZoomLevel int64 `json:"min_zoom_level,omitempty"`
}

LookmlModelExploreFieldMapLayer struct for LookmlModelExploreFieldMapLayer

type LookmlModelExploreFieldSqlCase 

type LookmlModelExploreFieldSqlCase struct {
	// SQL Case label value
	Value string `json:"value,omitempty"`
	// SQL Case condition expression
	Condition string `json:"condition,omitempty"`
}

LookmlModelExploreFieldSqlCase struct for LookmlModelExploreFieldSqlCase

type LookmlModelExploreFieldTimeInterval 

type LookmlModelExploreFieldTimeInterval struct {
	// The type of time interval this field represents a grouping of. Valid values are: \"day\", \"hour\", \"minute\", \"second\", \"millisecond\", \"microsecond\", \"month\", \"year\".
	Name string `json:"name,omitempty"`
	// The number of intervals this field represents a grouping of.
	Count int64 `json:"count,omitempty"`
}

LookmlModelExploreFieldTimeInterval struct for LookmlModelExploreFieldTimeInterval

type LookmlModelExploreFieldset 

type LookmlModelExploreFieldset struct {
	// Array of dimensions
	Dimensions []LookmlModelExploreField `json:"dimensions,omitempty"`
	// Array of measures
	Measures []LookmlModelExploreField `json:"measures,omitempty"`
	// Array of filters
	Filters []LookmlModelExploreField `json:"filters,omitempty"`
	// Array of parameters
	Parameters []LookmlModelExploreField `json:"parameters,omitempty"`
}

LookmlModelExploreFieldset struct for LookmlModelExploreFieldset

type LookmlModelExploreJoins 

type LookmlModelExploreJoins struct {
	// Name of this join (and name of the view to join)
	Name string `json:"name,omitempty"`
	// Fields referenced by the join
	DependentFields []string `json:"dependent_fields,omitempty"`
	// Fields of the joined view to pull into this explore
	Fields []string `json:"fields,omitempty"`
	// Name of the dimension in this explore whose value is in the primary key of the joined view
	ForeignKey string `json:"foreign_key,omitempty"`
	// Name of view to join
	From string `json:"from,omitempty"`
	// Specifies whether all queries must use an outer join
	OuterOnly bool `json:"outer_only,omitempty"`
	// many_to_one, one_to_one, one_to_many, many_to_many
	Relationship string `json:"relationship,omitempty"`
	// Names of joins that must always be included in SQL queries
	RequiredJoins []string `json:"required_joins,omitempty"`
	// SQL expression that produces a foreign key
	SqlForeignKey string `json:"sql_foreign_key,omitempty"`
	// SQL ON expression describing the join condition
	SqlOn string `json:"sql_on,omitempty"`
	// SQL table name to join
	SqlTableName string `json:"sql_table_name,omitempty"`
	// The join type: left_outer, full_outer, inner, or cross
	Type string `json:"type,omitempty"`
	// Label to display in UI selectors
	ViewLabel string `json:"view_label,omitempty"`
}

LookmlModelExploreJoins struct for LookmlModelExploreJoins

type LookmlModelExploreOpts 

type LookmlModelExploreOpts struct {
	Fields optional.String
}

LookmlModelExploreOpts Optional parameters for the method 'LookmlModelExplore'

type LookmlModelExploreSet 

type LookmlModelExploreSet struct {
	// Name
	Name string `json:"name,omitempty"`
	// Value set
	Value []string `json:"value,omitempty"`
}

LookmlModelExploreSet struct for LookmlModelExploreSet

type LookmlModelExploreSupportedMeasureType 

type LookmlModelExploreSupportedMeasureType struct {
	DimensionType string   `json:"dimension_type,omitempty"`
	MeasureTypes  []string `json:"measure_types,omitempty"`
}

LookmlModelExploreSupportedMeasureType struct for LookmlModelExploreSupportedMeasureType

type LookmlModelNavExplore 

type LookmlModelNavExplore struct {
	// Name of the explore
	Name string `json:"name,omitempty"`
	// Description for the explore
	Description string `json:"description,omitempty"`
	// Label for the explore
	Label string `json:"label,omitempty"`
	// Is this explore marked as hidden
	Hidden bool `json:"hidden,omitempty"`
	// Label used to group explores in the navigation menus
	GroupLabel string `json:"group_label,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

LookmlModelNavExplore struct for LookmlModelNavExplore

type LookmlModelOpts 

type LookmlModelOpts struct {
	Fields optional.String
}

LookmlModelOpts Optional parameters for the method 'LookmlModel'

type LookmlTest 

type LookmlTest struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of model containing this test.
	ModelName string `json:"model_name,omitempty"`
	// Name of this test.
	Name string `json:"name,omitempty"`
	// Name of the explore this test runs a query against
	ExploreName string `json:"explore_name,omitempty"`
	// The url parameters that can be used to reproduce this test's query on an explore.
	QueryUrlParams string `json:"query_url_params,omitempty"`
	// Name of the LookML file containing this test.
	File string `json:"file,omitempty"`
	// Line number of this test in LookML.
	Line int64 `json:"line,omitempty"`
}

LookmlTest struct for LookmlTest

type LookmlTestResult 

type LookmlTestResult struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of model containing this test.
	ModelName string `json:"model_name,omitempty"`
	// Name of this test.
	TestName string `json:"test_name,omitempty"`
	// Number of assertions in this test
	AssertionsCount int64 `json:"assertions_count,omitempty"`
	// Number of assertions passed in this test
	AssertionsFailed int64 `json:"assertions_failed,omitempty"`
	// A list of any errors encountered by the test.
	Errors []ProjectError `json:"errors,omitempty"`
	// A list of any warnings encountered by the test.
	Warnings []ProjectError `json:"warnings,omitempty"`
	// True if this test passsed without errors.
	Success bool `json:"success,omitempty"`
}

LookmlTestResult struct for LookmlTestResult

type Manifest 

type Manifest struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Manifest project name
	Name string `json:"name,omitempty"`
	// Imports for a project
	Imports              []ImportedProject    `json:"imports,omitempty"`
	LocalizationSettings LocalizationSettings `json:"localization_settings,omitempty"`
}

Manifest struct for Manifest

type MeOpts 

type MeOpts struct {
	Fields optional.String
}

MeOpts Optional parameters for the method 'Me'

type MergeFields 

type MergeFields struct {
	// Field name to map onto in the merged results
	FieldName string `json:"field_name,omitempty"`
	// Field name from the source query
	SourceFieldName string `json:"source_field_name,omitempty"`
}

MergeFields struct for MergeFields

type MergeQuery 

type MergeQuery struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Column Limit
	ColumnLimit string `json:"column_limit,omitempty"`
	// Dynamic Fields
	DynamicFields string `json:"dynamic_fields,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Pivots
	Pivots []string `json:"pivots,omitempty"`
	// Unique to get results
	ResultMakerId int64 `json:"result_maker_id,omitempty"`
	// Sorts
	Sorts []string `json:"sorts,omitempty"`
	// Source Queries defining the results to be merged.
	SourceQueries []MergeQuerySourceQuery `json:"source_queries,omitempty"`
	// Total
	Total bool `json:"total,omitempty"`
	// Visualization Config
	VisConfig map[string]string `json:"vis_config,omitempty"`
}

MergeQuery struct for MergeQuery

type MergeQueryOpts 

type MergeQueryOpts struct {
	Fields optional.String
}

MergeQueryOpts Optional parameters for the method 'MergeQuery'

type MergeQuerySourceQuery 

type MergeQuerySourceQuery struct {
	// An array defining which fields of the source query are mapped onto fields of the merge query
	MergeFields []MergeFields `json:"merge_fields,omitempty"`
	// Display name
	Name string `json:"name,omitempty"`
	// Id of the query to merge
	QueryId int64 `json:"query_id,omitempty"`
}

MergeQuerySourceQuery struct for MergeQuerySourceQuery

type ModelSet 

type ModelSet struct {
	// Operations the current user is able to perform on this object
	Can       map[string]bool `json:"can,omitempty"`
	AllAccess bool            `json:"all_access,omitempty"`
	BuiltIn   bool            `json:"built_in,omitempty"`
	// Unique Id
	Id     int64    `json:"id,omitempty"`
	Models []string `json:"models,omitempty"`
	// Name of ModelSet
	Name string `json:"name,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

ModelSet struct for ModelSet

type ModelSetOpts 

type ModelSetOpts struct {
	Fields optional.String
}

ModelSetOpts Optional parameters for the method 'ModelSet'

type ModelsNotValidated 

type ModelsNotValidated struct {
	// Model name
	Name string `json:"name,omitempty"`
	// Project file
	ProjectFileId string `json:"project_file_id,omitempty"`
}

ModelsNotValidated struct for ModelsNotValidated

type OidcConfig 

type OidcConfig struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Allow alternate email-based login via '/login/email' for admins and for specified users with the 'login_special_email' permission. This option is useful as a fallback during ldap setup, if ldap config problems occur later, or if you need to support some users who are not in your ldap directory. Looker email/password logins are always disabled for regular users when ldap is enabled.
	AlternateEmailLoginAllowed bool `json:"alternate_email_login_allowed,omitempty"`
	// OpenID Provider Audience
	Audience string `json:"audience,omitempty"`
	// Users will not be allowed to login at all unless a role for them is found in OIDC if set to true
	AuthRequiresRole bool `json:"auth_requires_role,omitempty"`
	// OpenID Provider Authorization Url
	AuthorizationEndpoint string `json:"authorization_endpoint,omitempty"`
	// (Write-Only) Array of ids of groups that will be applied to new users the first time they login via OIDC
	DefaultNewUserGroupIds []int64 `json:"default_new_user_group_ids,omitempty"`
	// (Read-only) Groups that will be applied to new users the first time they login via OIDC
	DefaultNewUserGroups []Group `json:"default_new_user_groups,omitempty"`
	// (Write-Only) Array of ids of roles that will be applied to new users the first time they login via OIDC
	DefaultNewUserRoleIds []int64 `json:"default_new_user_role_ids,omitempty"`
	// (Read-only) Roles that will be applied to new users the first time they login via OIDC
	DefaultNewUserRoles []Role `json:"default_new_user_roles,omitempty"`
	// Enable/Disable OIDC authentication for the server
	Enabled bool `json:"enabled,omitempty"`
	// (Read-only) Array of mappings between OIDC Groups and Looker Roles
	Groups []OidcGroupRead `json:"groups,omitempty"`
	// Name of user record attributes used to indicate groups. Used when 'groups_finder_type' is set to 'grouped_attribute_values'
	GroupsAttribute string `json:"groups_attribute,omitempty"`
	// (Read/Write) Array of mappings between OIDC Groups and arrays of Looker Role ids
	GroupsWithRoleIds []OidcGroupWrite `json:"groups_with_role_ids,omitempty"`
	// Relying Party Identifier (provided by OpenID Provider)
	Identifier string `json:"identifier,omitempty"`
	// OpenID Provider Issuer
	Issuer string `json:"issuer,omitempty"`
	// When this config was last modified
	ModifiedAt time.Time `json:"modified_at,omitempty"`
	// User id of user who last modified this config
	ModifiedBy int64 `json:"modified_by,omitempty"`
	// Merge first-time oidc login to existing user account by email addresses. When a user logs in for the first time via oidc this option will connect this user into their existing account by finding the account with a matching email address by testing the given types of credentials for existing users. Otherwise a new user account will be created for the user. This list (if provided) must be a comma separated list of string like 'email,ldap,google'
	NewUserMigrationTypes string `json:"new_user_migration_types,omitempty"`
	// Array of scopes to request.
	Scopes []string `json:"scopes,omitempty"`
	// (Write-Only) Relying Party Secret (provided by OpenID Provider)
	Secret string `json:"secret,omitempty"`
	// Set user roles in Looker based on groups from OIDC
	SetRolesFromGroups bool `json:"set_roles_from_groups,omitempty"`
	// Slug to identify configurations that are created in order to run a OIDC config test
	TestSlug string `json:"test_slug,omitempty"`
	// OpenID Provider Token Url
	TokenEndpoint string `json:"token_endpoint,omitempty"`
	// Name of user record attributes used to indicate email address field
	UserAttributeMapEmail string `json:"user_attribute_map_email,omitempty"`
	// Name of user record attributes used to indicate first name
	UserAttributeMapFirstName string `json:"user_attribute_map_first_name,omitempty"`
	// Name of user record attributes used to indicate last name
	UserAttributeMapLastName string `json:"user_attribute_map_last_name,omitempty"`
	// (Read-only) Array of mappings between OIDC User Attributes and Looker User Attributes
	UserAttributes []OidcUserAttributeRead `json:"user_attributes,omitempty"`
	// (Read/Write) Array of mappings between OIDC User Attributes and arrays of Looker User Attribute ids
	UserAttributesWithIds []OidcUserAttributeWrite `json:"user_attributes_with_ids,omitempty"`
	// OpenID Provider User Information Url
	UserinfoEndpoint string `json:"userinfo_endpoint,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

OidcConfig struct for OidcConfig

type OidcGroupRead 

type OidcGroupRead struct {
	// Name of group in OIDC
	Name string `json:"name,omitempty"`
	// Looker Roles
	Roles []Role `json:"roles,omitempty"`
}

OidcGroupRead struct for OidcGroupRead

type OidcGroupWrite 

type OidcGroupWrite struct {
	// Name of group in OIDC
	Name string `json:"name,omitempty"`
	// Looker Role Ids
	RoleIds []int64 `json:"role_ids,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

OidcGroupWrite struct for OidcGroupWrite

type OidcUserAttributeRead 

type OidcUserAttributeRead struct {
	// Name of User Attribute in OIDC
	Name string `json:"name,omitempty"`
	// Required to be in OIDC assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attributes
	UserAttributes []UserAttribute `json:"user_attributes,omitempty"`
}

OidcUserAttributeRead struct for OidcUserAttributeRead

type OidcUserAttributeWrite 

type OidcUserAttributeWrite struct {
	// Name of User Attribute in OIDC
	Name string `json:"name,omitempty"`
	// Required to be in OIDC assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attribute Ids
	UserAttributeIds []int64 `json:"user_attribute_ids,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

OidcUserAttributeWrite struct for OidcUserAttributeWrite

type PasswordConfig 

type PasswordConfig struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Minimum number of characters required for a new password.  Must be between 7 and 100
	MinLength int64 `json:"min_length,omitempty"`
	// Require at least one numeric character
	RequireNumeric bool `json:"require_numeric,omitempty"`
	// Require at least one uppercase and one lowercase letter
	RequireUpperlower bool `json:"require_upperlower,omitempty"`
	// Require at least one special character
	RequireSpecial bool `json:"require_special,omitempty"`
}

PasswordConfig struct for PasswordConfig

type Permission 

type Permission struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Permission symbol
	Permission string `json:"permission,omitempty"`
	// Dependency parent symbol
	Parent string `json:"parent,omitempty"`
	// Description
	Description string `json:"description,omitempty"`
}

Permission struct for Permission

type PermissionSet 

type PermissionSet struct {
	// Operations the current user is able to perform on this object
	Can       map[string]bool `json:"can,omitempty"`
	AllAccess bool            `json:"all_access,omitempty"`
	BuiltIn   bool            `json:"built_in,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Name of PermissionSet
	Name        string   `json:"name,omitempty"`
	Permissions []string `json:"permissions,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

PermissionSet struct for PermissionSet

type PermissionSetOpts 

type PermissionSetOpts struct {
	Fields optional.String
}

PermissionSetOpts Optional parameters for the method 'PermissionSet'

type Project 

type Project struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Project Id
	Id string `json:"id,omitempty"`
	// Project display name
	Name string `json:"name,omitempty"`
	// If true the project is configured with a git repository
	UsesGit bool `json:"uses_git,omitempty"`
	// Git remote repository url
	GitRemoteUrl string `json:"git_remote_url,omitempty"`
	// Git username for HTTPS authentication. (For production only, if using user attributes.)
	GitUsername string `json:"git_username,omitempty"`
	// (Write-Only) Git password for HTTPS authentication. (For production only, if using user attributes.)
	GitPassword string `json:"git_password,omitempty"`
	// User attribute name for username in per-user HTTPS authentication.
	GitUsernameUserAttribute string `json:"git_username_user_attribute,omitempty"`
	// User attribute name for password in per-user HTTPS authentication.
	GitPasswordUserAttribute string `json:"git_password_user_attribute,omitempty"`
	// Name of the git service provider
	GitServiceName string `json:"git_service_name,omitempty"`
	// (Write-Only) Optional secret token with which to authenticate requests to the webhook deploy endpoint. If not set, endpoint is unauthenticated.
	DeploySecret string `json:"deploy_secret,omitempty"`
	// (Write-Only) When true, unsets the deploy secret to allow unauthenticated access to the webhook deploy endpoint.
	UnsetDeploySecret bool `json:"unset_deploy_secret,omitempty"`
	// The git pull request policy for this project. Valid values are: \"off\", \"links\", \"recommended\", \"required\".
	PullRequestMode string `json:"pull_request_mode,omitempty"`
	// Validation policy: If true, the project must pass validation checks before project changes can be committed to the git repository
	ValidationRequired bool `json:"validation_required,omitempty"`
	// If true, folders are enabled for this project
	FoldersEnabled bool `json:"folders_enabled,omitempty"`
	// Validation policy: If true, the project can be committed with warnings when `validation_required` is true. (`allow_warnings` does nothing if `validation_required` is false).
	AllowWarnings bool `json:"allow_warnings,omitempty"`
	// If true the project is an example project and cannot be modified
	IsExample bool `json:"is_example,omitempty"`
}

Project struct for Project

type ProjectApiService 

type ProjectApiService service

ProjectApiService ProjectApi service

func (*ProjectApiService) AllGitBranches 

func (a *ProjectApiService) AllGitBranches(ctx _context.Context, projectId string) ([]GitBranch, *_nethttp.Response, error)

AllGitBranches Get All Git Branches ### Get All Git Branches Returns a list of git branches in the project repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id

@return []GitBranch

func (*ProjectApiService) AllGitConnectionTests 

func (a *ProjectApiService) AllGitConnectionTests(ctx _context.Context, projectId string, localVarOptionals *AllGitConnectionTestsOpts) ([]GitConnectionTest, *_nethttp.Response, error)

AllGitConnectionTests Get All Git Connection Tests ### Get All Git Connection Tests dev mode required. - Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. Returns a list of tests which can be run against a project&#39;s (or the dependency project for the provided remote_url) git connection. Call [Run Git Connection Test](#!/Project/run_git_connection_test) to execute each test in sequence. Tests are ordered by increasing specificity. Tests should be run in the order returned because later tests require functionality tested by tests earlier in the test list. For example, a late-stage test for write access is meaningless if connecting to the git server (an early test) is failing.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *AllGitConnectionTestsOpts - Optional Parameters:
  • @param "RemoteUrl" (optional.String) - (Optional: leave blank for root project) The remote url for remote dependency to test.

@return []GitConnectionTest

func (*ProjectApiService) AllLookmlTests 

func (a *ProjectApiService) AllLookmlTests(ctx _context.Context, projectId string, localVarOptionals *AllLookmlTestsOpts) ([]LookmlTest, *_nethttp.Response, error)

AllLookmlTests Get All LookML Tests ### Get All LookML Tests Returns a list of tests which can be run to validate a project&#39;s LookML code and/or the underlying data, optionally filtered by the file id. Call [Run LookML Test](#!/Project/run_lookml_test) to execute tests.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *AllLookmlTestsOpts - Optional Parameters:
  • @param "FileId" (optional.String) - File Id

@return []LookmlTest

func (*ProjectApiService) AllProjectFiles 

func (a *ProjectApiService) AllProjectFiles(ctx _context.Context, projectId string, localVarOptionals *AllProjectFilesOpts) ([]ProjectFile, *_nethttp.Response, error)

AllProjectFiles Get All Project Files ### Get All Project Files Returns a list of the files in the project

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *AllProjectFilesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return []ProjectFile

func (*ProjectApiService) AllProjects 

func (a *ProjectApiService) AllProjects(ctx _context.Context, localVarOptionals *AllProjectsOpts) ([]Project, *_nethttp.Response, error)

AllProjects Get All Projects ### Get All Projects Returns all projects visible to the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllProjectsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return []Project

func (*ProjectApiService) CreateGitBranch 

func (a *ProjectApiService) CreateGitBranch(ctx _context.Context, projectId string, body GitBranch) (GitBranch, *_nethttp.Response, error)

CreateGitBranch Checkout New Git Branch ### Create and Checkout a Git Branch Creates and checks out a new branch in the given project repository Only allowed in development mode - Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. Optionally specify a branch name, tag name or commit SHA as the start point in the ref field. If no ref is specified, HEAD of the current branch will be used as the start point for the new branch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param body Git Branch

@return GitBranch

func (*ProjectApiService) CreateGitDeployKey 

func (a *ProjectApiService) CreateGitDeployKey(ctx _context.Context, projectId string) (string, *_nethttp.Response, error)

CreateGitDeployKey Create Deploy Key ### Create Git Deploy Key Create a public/private key pair for authenticating ssh git requests from Looker to a remote git repository for a particular Looker project. Returns the public key of the generated ssh key pair. Copy this public key to your remote git repository&#39;s ssh keys configuration so that the remote git service can validate and accept git requests from the Looker server.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id

@return string

func (*ProjectApiService) CreateProject 

func (a *ProjectApiService) CreateProject(ctx _context.Context, body Project) (Project, *_nethttp.Response, error)

CreateProject Create Project ### Create A Project dev mode required. - Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. &#x60;name&#x60; is required. &#x60;git_remote_url&#x60; is not allowed. To configure Git for the newly created project, follow the instructions in &#x60;update_project&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Project

@return Project

func (*ProjectApiService) DeleteGitBranch 

func (a *ProjectApiService) DeleteGitBranch(ctx _context.Context, projectId string, branchName string) (string, *_nethttp.Response, error)

DeleteGitBranch Delete a Git Branch ### Delete the specified Git Branch Delete git branch specified in branch_name path param from local and remote of specified project repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param branchName Branch Name

@return string

func (*ProjectApiService) DeleteRepositoryCredential 

func (a *ProjectApiService) DeleteRepositoryCredential(ctx _context.Context, rootProjectId string, credentialId string) (string, *_nethttp.Response, error)

DeleteRepositoryCredential Delete Repository Credential ### Repository Credential for a remote dependency Admin required. &#x60;root_project_id&#x60; is required. &#x60;credential_id&#x60; is required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param rootProjectId Root Project Id
  • @param credentialId Credential Id

@return string

func (*ProjectApiService) DeployToProduction 

func (a *ProjectApiService) DeployToProduction(ctx _context.Context, projectId string) (string, *_nethttp.Response, error)

DeployToProduction Deploy To Production ### Deploy LookML from this Development Mode Project to Production Git must have been configured, must be in dev mode and deploy permission required Deploy is a two / three step process 1. Push commits in current branch of dev mode project to the production branch (origin/master). Note a. This step is skipped in read-only projects. Note b. If this step is unsuccessful for any reason (e.g. rejected non-fastforward because production branch has commits not in current branch), subsequent steps will be skipped. 2. If this is the first deploy of this project, create the production project with git repository. 3. Pull the production branch into the production project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Id of project

@return string

func (*ProjectApiService) FindGitBranch 

func (a *ProjectApiService) FindGitBranch(ctx _context.Context, projectId string, branchName string) (GitBranch, *_nethttp.Response, error)

FindGitBranch Find a Git Branch ### Get the specified Git Branch Returns the git branch specified in branch_name path param if it exists in the given project repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param branchName Branch Name

@return GitBranch

func (*ProjectApiService) GetAllRepositoryCredentials 

func (a *ProjectApiService) GetAllRepositoryCredentials(ctx _context.Context, rootProjectId string) ([]RepositoryCredential, *_nethttp.Response, error)

GetAllRepositoryCredentials Get All Repository Credentials ### Get all Repository Credentials for a project &#x60;root_project_id&#x60; is required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param rootProjectId Root Project Id

@return []RepositoryCredential

func (*ProjectApiService) GitBranch 

func (a *ProjectApiService) GitBranch(ctx _context.Context, projectId string) (GitBranch, *_nethttp.Response, error)

GitBranch Get Active Git Branch ### Get the Current Git Branch Returns the git branch currently checked out in the given project repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id

@return GitBranch

func (*ProjectApiService) GitDeployKey 

func (a *ProjectApiService) GitDeployKey(ctx _context.Context, projectId string) (string, *_nethttp.Response, error)

GitDeployKey Git Deploy Key ### Git Deploy Key Returns the ssh public key previously created for a project&#39;s git repository.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id

@return string

func (*ProjectApiService) Manifest 

func (a *ProjectApiService) Manifest(ctx _context.Context, projectId string) (Manifest, *_nethttp.Response, error)

Manifest Get Manifest ### Get A Projects Manifest object Returns the project with the given project id

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id

@return Manifest

func (*ProjectApiService) Project 

func (a *ProjectApiService) Project(ctx _context.Context, projectId string, localVarOptionals *ProjectOpts) (Project, *_nethttp.Response, error)

Project Get Project ### Get A Project Returns the project with the given project id

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *ProjectOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return Project

func (*ProjectApiService) ProjectFile 

func (a *ProjectApiService) ProjectFile(ctx _context.Context, projectId string, fileId string, localVarOptionals *ProjectFileOpts) (ProjectFile, *_nethttp.Response, error)

ProjectFile Get Project File ### Get Project File Info Returns information about a file in the project

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param fileId File Id
  • @param optional nil or *ProjectFileOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return ProjectFile

func (*ProjectApiService) ProjectValidationResults 

func (a *ProjectApiService) ProjectValidationResults(ctx _context.Context, projectId string, localVarOptionals *ProjectValidationResultsOpts) (ProjectValidationCache, *_nethttp.Response, error)

ProjectValidationResults Cached Project Validation Results ### Get Cached Project Validation Results Returns the cached results of a previous project validation calculation, if any. Returns http status 204 No Content if no validation results exist. Validating the content of all the files in a project can be computationally intensive for large projects. Use this API to simply fetch the results of the most recent project validation rather than revalidating the entire project from scratch. A value of &#x60;\&quot;stale\&quot;: true&#x60; in the response indicates that the project has changed since the cached validation results were computed. The cached validation results may no longer reflect the current state of the project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *ProjectValidationResultsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return ProjectValidationCache

func (*ProjectApiService) ProjectWorkspace 

func (a *ProjectApiService) ProjectWorkspace(ctx _context.Context, projectId string, localVarOptionals *ProjectWorkspaceOpts) (ProjectWorkspace, *_nethttp.Response, error)

ProjectWorkspace Get Project Workspace ### Get Project Workspace Returns information about the state of the project files in the currently selected workspace

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *ProjectWorkspaceOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return ProjectWorkspace

func (*ProjectApiService) ResetProjectToProduction 

func (a *ProjectApiService) ResetProjectToProduction(ctx _context.Context, projectId string) (string, *_nethttp.Response, error)

ResetProjectToProduction Reset To Production ### Reset a project to the revision of the project that is in production. **DANGER** this will delete any changes that have not been pushed to a remote repository.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Id of project

@return string

func (*ProjectApiService) ResetProjectToRemote 

func (a *ProjectApiService) ResetProjectToRemote(ctx _context.Context, projectId string) (string, *_nethttp.Response, error)

ResetProjectToRemote Reset To Remote ### Reset a project development branch to the revision of the project that is on the remote. **DANGER** this will delete any changes that have not been pushed to a remote repository.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Id of project

@return string

func (*ProjectApiService) RunGitConnectionTest 

func (a *ProjectApiService) RunGitConnectionTest(ctx _context.Context, projectId string, testId string, localVarOptionals *RunGitConnectionTestOpts) (GitConnectionTestResult, *_nethttp.Response, error)

RunGitConnectionTest Run Git Connection Test ### Run a git connection test Run the named test on the git service used by this project (or the dependency project for the provided remote_url) and return the result. This is intended to help debug git connections when things do not work properly, to give more helpful information about why a git url is not working with Looker. Tests should be run in the order they are returned by [Get All Git Connection Tests](#!/Project/all_git_connection_tests).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param testId Test Id
  • @param optional nil or *RunGitConnectionTestOpts - Optional Parameters:
  • @param "RemoteUrl" (optional.String) - (Optional: leave blank for root project) The remote url for remote dependency to test.

@return GitConnectionTestResult

func (*ProjectApiService) RunLookmlTest 

func (a *ProjectApiService) RunLookmlTest(ctx _context.Context, projectId string, localVarOptionals *RunLookmlTestOpts) ([]LookmlTestResult, *_nethttp.Response, error)

RunLookmlTest Run LookML Test ### Run LookML Tests Runs all tests in the project, optionally filtered by file, test, and/or model.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *RunLookmlTestOpts - Optional Parameters:
  • @param "FileId" (optional.String) - File Name
  • @param "Test" (optional.String) - Test Name
  • @param "Model" (optional.String) - Model Name

@return []LookmlTestResult

func (*ProjectApiService) UpdateGitBranch 

func (a *ProjectApiService) UpdateGitBranch(ctx _context.Context, projectId string, body GitBranch) (GitBranch, *_nethttp.Response, error)

UpdateGitBranch Update Project Git Branch ### Checkout and/or reset --hard an existing Git Branch Only allowed in development mode - Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. Checkout an existing branch if name field is different from the name of the currently checked out branch. Optionally specify a branch name, tag name or commit SHA to which the branch should be reset. **DANGER** hard reset will be force pushed to the remote. Unsaved changes and commits may be permanently lost.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param body Git Branch

@return GitBranch

func (*ProjectApiService) UpdateProject 

func (a *ProjectApiService) UpdateProject(ctx _context.Context, projectId string, body Project, localVarOptionals *UpdateProjectOpts) (Project, *_nethttp.Response, error)

UpdateProject Update Project ### Update Project Configuration Apply changes to a project&#39;s configuration. #### Configuring Git for a Project To set up a Looker project with a remote git repository, follow these steps: 1. Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. 1. Call &#x60;create_git_deploy_key&#x60; to create a new deploy key for the project 1. Copy the deploy key text into the remote git repository&#39;s ssh key configuration 1. Call &#x60;update_project&#x60; to set project&#39;s &#x60;git_remote_url&#x60; ()and &#x60;git_service_name&#x60;, if necessary). When you modify a project&#39;s &#x60;git_remote_url&#x60;, Looker connects to the remote repository to fetch metadata. The remote git repository MUST be configured with the Looker-generated deploy key for this project prior to setting the project&#39;s &#x60;git_remote_url&#x60;. To set up a Looker project with a git repository residing on the Looker server (a &#39;bare&#39; git repo): 1. Call &#x60;update_session&#x60; to select the &#39;dev&#39; workspace. 1. Call &#x60;update_project&#x60; setting &#x60;git_remote_url&#x60; to nil and &#x60;git_service_name&#x60; to \&quot;bare\&quot;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param body Project
  • @param optional nil or *UpdateProjectOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return Project

func (*ProjectApiService) UpdateRepositoryCredential 

func (a *ProjectApiService) UpdateRepositoryCredential(ctx _context.Context, rootProjectId string, credentialId string, body RepositoryCredential) (RepositoryCredential, *_nethttp.Response, error)

UpdateRepositoryCredential Create Repository Credential ### Configure Repository Credential for a remote dependency Admin required. &#x60;root_project_id&#x60; is required. &#x60;credential_id&#x60; is required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param rootProjectId Root Project Id
  • @param credentialId Credential Id
  • @param body Remote Project Information

@return RepositoryCredential

func (*ProjectApiService) ValidateProject 

func (a *ProjectApiService) ValidateProject(ctx _context.Context, projectId string, localVarOptionals *ValidateProjectOpts) (ProjectValidation, *_nethttp.Response, error)

ValidateProject Validate Project ### Validate Project Performs lint validation of all lookml files in the project. Returns a list of errors found, if any. Validating the content of all the files in a project can be computationally intensive for large projects. For best performance, call &#x60;validate_project(project_id)&#x60; only when you really want to recompute project validation. To quickly display the results of the most recent project validation (without recomputing), use &#x60;project_validation_results(project_id)&#x60;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project Id
  • @param optional nil or *ValidateProjectOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return ProjectValidation

type ProjectError 

type ProjectError struct {
	// A stable token that uniquely identifies this class of error, ignoring parameter values. Error message text may vary due to parameters or localization, but error codes do not. For example, a \"File not found\" error will have the same error code regardless of the filename in question or the user's display language
	Code string `json:"code,omitempty"`
	// Severity: fatal, error, warning, info, success
	Severity string `json:"severity,omitempty"`
	// Error classification: syntax, deprecation, model_configuration, etc
	Kind string `json:"kind,omitempty"`
	// Error message which may contain information such as dashboard or model names that may be considered sensitive in some use cases. Avoid storing or sending this message outside of Looker
	Message string `json:"message,omitempty"`
	// The field associated with this error
	FieldName string `json:"field_name,omitempty"`
	// Name of the file containing this error
	FilePath string `json:"file_path,omitempty"`
	// Line number in the file of this error
	LineNumber int64 `json:"line_number,omitempty"`
	// The model associated with this error
	ModelId string `json:"model_id,omitempty"`
	// The explore associated with this error
	Explore string `json:"explore,omitempty"`
	// A link to Looker documentation about this error
	HelpUrl string `json:"help_url,omitempty"`
	// Error parameters
	Params map[string]string `json:"params,omitempty"`
	// A version of the error message that does not contain potentially sensitive information. Suitable for situations in which messages are stored or sent to consumers outside of Looker, such as external logs. Sanitized messages will display \"(?)\" where sensitive information would appear in the corresponding non-sanitized message
	SanitizedMessage string `json:"sanitized_message,omitempty"`
}

ProjectError struct for ProjectError

type ProjectFile 

type ProjectFile struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// An opaque token uniquely identifying a file within a project. Avoid parsing or decomposing the text of this token. This token is stable within a Looker release but may change between Looker releases
	Id string `json:"id,omitempty"`
	// Path, file name, and extension of the file relative to the project root directory
	Path string `json:"path,omitempty"`
	// Display name
	Title string `json:"title,omitempty"`
	// File type: model, view, etc
	Type string `json:"type,omitempty"`
	// The extension of the file: .view.lkml, .model.lkml, etc
	Extension string `json:"extension,omitempty"`
	// File mime type
	MimeType string `json:"mime_type,omitempty"`
	// State of editability for the file.
	Editable  bool      `json:"editable,omitempty"`
	GitStatus GitStatus `json:"git_status,omitempty"`
}

ProjectFile struct for ProjectFile

type ProjectFileOpts 

type ProjectFileOpts struct {
	Fields optional.String
}

ProjectFileOpts Optional parameters for the method 'ProjectFile'

type ProjectOpts 

type ProjectOpts struct {
	Fields optional.String
}

ProjectOpts Optional parameters for the method 'Project'

type ProjectValidation 

type ProjectValidation struct {
	// A list of project errors
	Errors []ProjectError `json:"errors,omitempty"`
	// A hash value computed from the project's current state
	ProjectDigest string `json:"project_digest,omitempty"`
	// A list of models which were not fully validated
	ModelsNotValidated []ModelsNotValidated `json:"models_not_validated,omitempty"`
	// Duration of project validation in seconds
	ComputationTime float32 `json:"computation_time,omitempty"`
}

ProjectValidation struct for ProjectValidation

type ProjectValidationCache 

type ProjectValidationCache struct {
	// A list of project errors
	Errors []ProjectError `json:"errors,omitempty"`
	// A hash value computed from the project's current state
	ProjectDigest string `json:"project_digest,omitempty"`
	// A list of models which were not fully validated
	ModelsNotValidated []ModelsNotValidated `json:"models_not_validated,omitempty"`
	// Duration of project validation in seconds
	ComputationTime float32 `json:"computation_time,omitempty"`
	// If true, the cached project validation results are no longer accurate because the project has changed since the cached results were calculated
	Stale bool `json:"stale,omitempty"`
}

ProjectValidationCache struct for ProjectValidationCache

type ProjectValidationResultsOpts 

type ProjectValidationResultsOpts struct {
	Fields optional.String
}

ProjectValidationResultsOpts Optional parameters for the method 'ProjectValidationResults'

type ProjectWorkspace 

type ProjectWorkspace struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The id of the project
	ProjectId string `json:"project_id,omitempty"`
	// The id of the local workspace containing the project files
	WorkspaceId string `json:"workspace_id,omitempty"`
	// The status of the local git directory
	GitStatus string `json:"git_status,omitempty"`
	// Git head revision name
	GitHead   string    `json:"git_head,omitempty"`
	GitBranch GitBranch `json:"git_branch,omitempty"`
	// The lookml syntax used by all files in this project
	LookmlType string `json:"lookml_type,omitempty"`
}

ProjectWorkspace struct for ProjectWorkspace

type ProjectWorkspaceOpts 

type ProjectWorkspaceOpts struct {
	Fields optional.String
}

ProjectWorkspaceOpts Optional parameters for the method 'ProjectWorkspace'

type Query 

type Query struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Model
	Model string `json:"model"`
	// Explore Name
	View string `json:"view"`
	// Fields
	Fields []string `json:"fields,omitempty"`
	// Pivots
	Pivots []string `json:"pivots,omitempty"`
	// Fill Fields
	FillFields []string `json:"fill_fields,omitempty"`
	// Filters
	Filters map[string]string `json:"filters,omitempty"`
	// Filter Expression
	FilterExpression string `json:"filter_expression,omitempty"`
	// Sorting for the query results. Use the format `[\"view.field\", ...]` to sort on fields in ascending order. Use the format `[\"view.field desc\", ...]` to sort on fields in descending order. Use `[\"__UNSORTED__\"]` (2 underscores before and after) to disable sorting entirely. Empty sorts `[]` will trigger a default sort.
	Sorts []string `json:"sorts,omitempty"`
	// Limit
	Limit string `json:"limit,omitempty"`
	// Column Limit
	ColumnLimit string `json:"column_limit,omitempty"`
	// Total
	Total bool `json:"total,omitempty"`
	// Raw Total
	RowTotal string `json:"row_total,omitempty"`
	// Fields on which to run subtotals
	Subtotals []string `json:"subtotals,omitempty"`
	// Runtime
	Runtime float64 `json:"runtime,omitempty"`
	// Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A \"type\" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
	VisConfig map[string]string `json:"vis_config,omitempty"`
	// The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over \"filters\". When creating a query or modifying an existing query, \"filter_config\" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.
	FilterConfig map[string]string `json:"filter_config,omitempty"`
	// Visible UI Sections
	VisibleUiSections string `json:"visible_ui_sections,omitempty"`
	// Slug
	Slug string `json:"slug,omitempty"`
	// Dynamic Fields
	DynamicFields string `json:"dynamic_fields,omitempty"`
	// Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.
	ClientId string `json:"client_id,omitempty"`
	// Share Url
	ShareUrl string `json:"share_url,omitempty"`
	// Expanded Share Url
	ExpandedShareUrl string `json:"expanded_share_url,omitempty"`
	// Expanded Url
	Url string `json:"url,omitempty"`
	// Query Timezone
	QueryTimezone string `json:"query_timezone,omitempty"`
	// Has Table Calculations
	HasTableCalculations bool `json:"has_table_calculations,omitempty"`
}

Query struct for Query

type QueryApiService 

type QueryApiService service

QueryApiService QueryApi service

func (*QueryApiService) AllRunningQueries 

func (a *QueryApiService) AllRunningQueries(ctx _context.Context) ([]RunningQueries, *_nethttp.Response, error)

AllRunningQueries Get All Running Queries Get information about all running queries.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []RunningQueries

func (*QueryApiService) CreateMergeQuery 

func (a *QueryApiService) CreateMergeQuery(ctx _context.Context, localVarOptionals *CreateMergeQueryOpts) (MergeQuery, *_nethttp.Response, error)

CreateMergeQuery Create Merge Query ### Create Merge Query Creates a new merge query object. A merge query takes the results of one or more queries and combines (merges) the results according to field mapping definitions. The result is similar to a SQL left outer join. A merge query can merge results of queries from different SQL databases. The order that queries are defined in the source_queries array property is significant. The first query in the array defines the primary key into which the results of subsequent queries will be merged. Like model/view query objects, merge queries are immutable and have structural identity - if you make a request to create a new merge query that is identical to an existing merge query, the existing merge query will be returned instead of creating a duplicate. Conversely, any change to the contents of a merge query will produce a new object with a new id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateMergeQueryOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields
  • @param "Body" (optional.Interface of MergeQuery) - Merge Query

@return MergeQuery

func (*QueryApiService) CreateQuery 

func (a *QueryApiService) CreateQuery(ctx _context.Context, body Query, localVarOptionals *CreateQueryOpts) (Query, *_nethttp.Response, error)

CreateQuery Create Query ### Create a query. This allows you to create a new query that you can later run. Looker queries are immutable once created and are not deleted. If you create a query that is exactly like an existing query then the existing query will be returned and no new query will be created. Whether a new query is created or not, you can use the &#39;id&#39; in the returned query with the &#39;run&#39; method. The query parameters are passed as json in the body of the request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Query
  • @param optional nil or *CreateQueryOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Query

func (*QueryApiService) CreateQueryTask 

func (a *QueryApiService) CreateQueryTask(ctx _context.Context, body CreateQueryTask, localVarOptionals *CreateQueryTaskOpts) (QueryTask, *_nethttp.Response, error)

CreateQueryTask Run Query Async ### Create an async query task Creates a query task (job) to run a previously created query asynchronously. Returns a Query Task ID. Use [query_task(query_task_id)](#!/Query/query_task) to check the execution status of the query task. After the query task status reaches \&quot;Complete\&quot;, use [query_task_results(query_task_id)](#!/Query/query_task_results) to fetch the results of the query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Query parameters
  • @param optional nil or *CreateQueryTaskOpts - Optional Parameters:
  • @param "Limit" (optional.Int64) - Row limit (may override the limit in the saved query).
  • @param "ApplyFormatting" (optional.Bool) - Apply model-specified formatting to each result.
  • @param "ApplyVis" (optional.Bool) - Apply visualization options to results.
  • @param "Cache" (optional.Bool) - Get results from cache if available.
  • @param "ImageWidth" (optional.Int64) - Render width for image formats.
  • @param "ImageHeight" (optional.Int64) - Render height for image formats.
  • @param "GenerateDrillLinks" (optional.Bool) - Generate drill links (only applicable to 'json_detail' format.
  • @param "ForceProduction" (optional.Bool) - Force use of production models even if the user is in development mode.
  • @param "CacheOnly" (optional.Bool) - Retrieve any results from cache even if the results have expired.
  • @param "PathPrefix" (optional.String) - Prefix to use for drill links (url encoded).
  • @param "RebuildPdts" (optional.Bool) - Rebuild PDTS used in query.
  • @param "ServerTableCalcs" (optional.Bool) - Perform table calculations on query results
  • @param "Fields" (optional.String) - Requested fields

@return QueryTask

func (*QueryApiService) CreateSqlQuery 

func (a *QueryApiService) CreateSqlQuery(ctx _context.Context, body SqlQueryCreate) (SqlQuery, *_nethttp.Response, error)

CreateSqlQuery Create SQL Runner Query ### Create a SQL Runner Query Either the &#x60;connection_name&#x60; or &#x60;model_name&#x60; parameter MUST be provided.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body SQL Runner Query

@return SqlQuery

func (*QueryApiService) KillQuery 

func (a *QueryApiService) KillQuery(ctx _context.Context, queryTaskId string) (string, *_nethttp.Response, error)

KillQuery Kill Running Query Kill a query with a specific query_task_id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryTaskId Query task id.

@return string

func (*QueryApiService) MergeQuery 

func (a *QueryApiService) MergeQuery(ctx _context.Context, mergeQueryId string, localVarOptionals *MergeQueryOpts) (MergeQuery, *_nethttp.Response, error)

MergeQuery Get Merge Query ### Get Merge Query Returns a merge query object given its id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mergeQueryId Merge Query Id
  • @param optional nil or *MergeQueryOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields

@return MergeQuery

func (*QueryApiService) Query 

func (a *QueryApiService) Query(ctx _context.Context, queryId int64, localVarOptionals *QueryOpts) (Query, *_nethttp.Response, error)

Query Get Query ### Get a previously created query by id. A Looker query object includes the various parameters that define a database query that has been run or could be run in the future. These parameters include: model, view, fields, filters, pivots, etc. Query *results* are not part of the query object. Query objects are unique and immutable. Query objects are created automatically in Looker as users explore data. Looker does not delete them; they become part of the query history. When asked to create a query for any given set of parameters, Looker will first try to find an existing query object with matching parameters and will only create a new object when an appropriate object can not be found. This &#39;get&#39; method is used to get the details about a query for a given id. See the other methods here to &#39;create&#39; and &#39;run&#39; queries. Note that some fields like &#39;filter_config&#39; and &#39;vis_config&#39; etc are specific to how the Looker UI builds queries and visualizations and are not generally useful for API use. They are not required when creating new queries and can usually just be ignored.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryId Id of query
  • @param optional nil or *QueryOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Query

func (*QueryApiService) QueryForSlug 

func (a *QueryApiService) QueryForSlug(ctx _context.Context, slug string, localVarOptionals *QueryForSlugOpts) (Query, *_nethttp.Response, error)

QueryForSlug Get Query for Slug ### Get the query for a given query slug. This returns the query for the &#39;slug&#39; in a query share URL. The &#39;slug&#39; is a randomly chosen short string that is used as an alternative to the query&#39;s id value for use in URLs etc. This method exists as a convenience to help you use the API to &#39;find&#39; queries that have been created using the Looker UI. You can use the Looker explore page to build a query and then choose the &#39;Share&#39; option to show the share url for the query. Share urls generally look something like &#39;https://looker.yourcompany/x/vwGSbfc&#39;. The trailing &#39;vwGSbfc&#39; is the share slug. You can pass that string to this api method to get details about the query. Those details include the &#39;id&#39; that you can use to run the query. Or, you can copy the query body (perhaps with your own modification) and use that as the basis to make/run new queries. This will also work with slugs from Looker explore urls like &#39;https://looker.yourcompany/explore/ecommerce/orders?qid&#x3D;aogBgL6o3cKK1jN3RoZl5s&#39;. In this case &#39;aogBgL6o3cKK1jN3RoZl5s&#39; is the slug.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slug Slug of query
  • @param optional nil or *QueryForSlugOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Query

func (*QueryApiService) QueryTask 

func (a *QueryApiService) QueryTask(ctx _context.Context, queryTaskId string, localVarOptionals *QueryTaskOpts) (QueryTask, *_nethttp.Response, error)

QueryTask Get Async Query Info ### Get Query Task details Use this function to check the status of an async query task. After the status reaches \&quot;Complete\&quot;, you can call [query_task_results(query_task_id)](#!/Query/query_task_results) to retrieve the results of the query. Use [create_query_task()](#!/Query/create_query_task) to create an async query task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryTaskId ID of the Query Task
  • @param optional nil or *QueryTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return QueryTask

func (*QueryApiService) QueryTaskMultiResults 

func (a *QueryApiService) QueryTaskMultiResults(ctx _context.Context, queryTaskIds []string) (map[string]string, *_nethttp.Response, error)

QueryTaskMultiResults Get Multiple Async Query Results ### Fetch results of multiple async queries Returns the results of multiple async queries in one request. For Query Tasks that are not completed, the response will include the execution status of the Query Task but will not include query results. Query Tasks whose results have expired will have a status of &#39;expired&#39;. If the user making the API request does not have sufficient privileges to view a Query Task result, the result will have a status of &#39;missing&#39;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryTaskIds List of Query Task IDs

@return map[string]string

func (*QueryApiService) QueryTaskResults 

func (a *QueryApiService) QueryTaskResults(ctx _context.Context, queryTaskId string) (string, *_nethttp.Response, error)

QueryTaskResults Get Async Query Results ### Get Async Query Results Returns the results of an async query task if the query has completed. If the query task is still running or waiting to run, this function returns 204 No Content. If the query task ID is invalid or the cached results of the query task have expired, this function returns 404 Not Found. Use [query_task(query_task_id)](#!/Query/query_task) to check the execution status of the query task Call query_task_results only after the query task status reaches \&quot;Complete\&quot;. You can also use [query_task_multi_results()](#!/Query/query_task_multi_results) retrieve the results of multiple async query tasks at the same time. #### SQL Error Handling: If the query fails due to a SQL db error, how this is communicated depends on the result_format you requested in &#x60;create_query_task()&#x60;. For &#x60;json_detail&#x60; result_format: &#x60;query_task_results()&#x60; will respond with HTTP status &#39;200 OK&#39; and db SQL error info will be in the &#x60;errors&#x60; property of the response object. The &#39;data&#39; property will be empty. For all other result formats: &#x60;query_task_results()&#x60; will respond with HTTP status &#x60;400 Bad Request&#x60; and some db SQL error info will be in the message of the 400 error response, but not as detailed as expressed in &#x60;json_detail.errors&#x60;. These data formats can only carry row data, and error info is not row data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryTaskId ID of the Query Task

@return string

func (*QueryApiService) RunInlineQuery 

func (a *QueryApiService) RunInlineQuery(ctx _context.Context, resultFormat string, body Query, localVarOptionals *RunInlineQueryOpts) (string, *_nethttp.Response, error)

RunInlineQuery Run Inline Query ### Run the query that is specified inline in the posted body. This allows running a query as defined in json in the posted body. This combines the two actions of posting &amp; running a query into one step. Here is an example body in json: &#x60;&#x60;&#x60; { \&quot;model\&quot;:\&quot;thelook\&quot;, \&quot;view\&quot;:\&quot;inventory_items\&quot;, \&quot;fields\&quot;:[\&quot;category.name\&quot;,\&quot;inventory_items.days_in_inventory_tier\&quot;,\&quot;products.count\&quot;], \&quot;filters\&quot;:{\&quot;category.name\&quot;:\&quot;socks\&quot;}, \&quot;sorts\&quot;:[\&quot;products.count desc 0\&quot;], \&quot;limit\&quot;:\&quot;500\&quot;, \&quot;query_timezone\&quot;:\&quot;America/Los_Angeles\&quot; } &#x60;&#x60;&#x60; When using the Ruby SDK this would be passed as a Ruby hash like: &#x60;&#x60;&#x60; { :model&#x3D;&gt;\&quot;thelook\&quot;, :view&#x3D;&gt;\&quot;inventory_items\&quot;, :fields&#x3D;&gt; [\&quot;category.name\&quot;, \&quot;inventory_items.days_in_inventory_tier\&quot;, \&quot;products.count\&quot;], :filters&#x3D;&gt;{:\&quot;category.name\&quot;&#x3D;&gt;\&quot;socks\&quot;}, :sorts&#x3D;&gt;[\&quot;products.count desc 0\&quot;], :limit&#x3D;&gt;\&quot;500\&quot;, :query_timezone&#x3D;&gt;\&quot;America/Los_Angeles\&quot;, } &#x60;&#x60;&#x60; This will return the result of running the query in the format specified by the &#39;result_format&#39; parameter. Supported formats: | result_format | Description | :-----------: | :--- | | json | Plain json | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | md | Simple markdown | xlsx | MS Excel spreadsheet | sql | Returns the generated SQL rather than running the query | png | A PNG image of the visualization of the query | jpg | A JPG image of the visualization of the query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param resultFormat Format of result
  • @param body inline query
  • @param optional nil or *RunInlineQueryOpts - Optional Parameters:
  • @param "Limit" (optional.Int64) - Row limit (may override the limit in the saved query).
  • @param "ApplyFormatting" (optional.Bool) - Apply model-specified formatting to each result.
  • @param "ApplyVis" (optional.Bool) - Apply visualization options to results.
  • @param "Cache" (optional.Bool) - Get results from cache if available.
  • @param "ImageWidth" (optional.Int64) - Render width for image formats.
  • @param "ImageHeight" (optional.Int64) - Render height for image formats.
  • @param "GenerateDrillLinks" (optional.Bool) - Generate drill links (only applicable to 'json_detail' format.
  • @param "ForceProduction" (optional.Bool) - Force use of production models even if the user is in development mode.
  • @param "CacheOnly" (optional.Bool) - Retrieve any results from cache even if the results have expired.
  • @param "PathPrefix" (optional.String) - Prefix to use for drill links (url encoded).
  • @param "RebuildPdts" (optional.Bool) - Rebuild PDTS used in query.
  • @param "ServerTableCalcs" (optional.Bool) - Perform table calculations on query results

@return string

func (*QueryApiService) RunQuery 

func (a *QueryApiService) RunQuery(ctx _context.Context, queryId int64, resultFormat string, localVarOptionals *RunQueryOpts) (string, *_nethttp.Response, error)

RunQuery Run Query ### Run a saved query. This runs a previously saved query. You can use this on a query that was generated in the Looker UI or one that you have explicitly created using the API. You can also use a query &#39;id&#39; from a saved &#39;Look&#39;. The &#39;result_format&#39; parameter specifies the desired structure and format of the response. Supported formats: | result_format | Description | :-----------: | :--- | | json | Plain json | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | md | Simple markdown | xlsx | MS Excel spreadsheet | sql | Returns the generated SQL rather than running the query | png | A PNG image of the visualization of the query | jpg | A JPG image of the visualization of the query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryId Id of query
  • @param resultFormat Format of result
  • @param optional nil or *RunQueryOpts - Optional Parameters:
  • @param "Limit" (optional.Int64) - Row limit (may override the limit in the saved query).
  • @param "ApplyFormatting" (optional.Bool) - Apply model-specified formatting to each result.
  • @param "ApplyVis" (optional.Bool) - Apply visualization options to results.
  • @param "Cache" (optional.Bool) - Get results from cache if available.
  • @param "ImageWidth" (optional.Int64) - Render width for image formats.
  • @param "ImageHeight" (optional.Int64) - Render height for image formats.
  • @param "GenerateDrillLinks" (optional.Bool) - Generate drill links (only applicable to 'json_detail' format.
  • @param "ForceProduction" (optional.Bool) - Force use of production models even if the user is in development mode.
  • @param "CacheOnly" (optional.Bool) - Retrieve any results from cache even if the results have expired.
  • @param "PathPrefix" (optional.String) - Prefix to use for drill links (url encoded).
  • @param "RebuildPdts" (optional.Bool) - Rebuild PDTS used in query.
  • @param "ServerTableCalcs" (optional.Bool) - Perform table calculations on query results

@return string

func (*QueryApiService) RunSqlQuery 

func (a *QueryApiService) RunSqlQuery(ctx _context.Context, slug string, resultFormat string, localVarOptionals *RunSqlQueryOpts) (string, *_nethttp.Response, error)

RunSqlQuery Run SQL Runner Query Execute a SQL Runner query in a given result_format.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slug slug of query
  • @param resultFormat Format of result, options are: [\"json\", \"json_detail\", \"json_fe\", \"csv\", \"html\", \"md\", \"txt\", \"xlsx\", \"gsxml\", \"json_label\"]
  • @param optional nil or *RunSqlQueryOpts - Optional Parameters:
  • @param "Download" (optional.String) - Defaults to false. If set to true, the HTTP response will have content-disposition and other headers set to make the HTTP response behave as a downloadable attachment instead of as inline content.

@return string

func (*QueryApiService) RunUrlEncodedQuery 

func (a *QueryApiService) RunUrlEncodedQuery(ctx _context.Context, modelName string, viewName string, resultFormat string) (string, *_nethttp.Response, error)

RunUrlEncodedQuery Run Url Encoded Query ### Run an URL encoded query. This requires the caller to encode the specifiers for the query into the URL query part using Looker-specific syntax as explained below. Generally, you would want to use one of the methods that takes the parameters as json in the POST body for creating and/or running queries. This method exists for cases where one really needs to encode the parameters into the URL of a single &#39;GET&#39; request. This matches the way that the Looker UI formats &#39;explore&#39; URLs etc. The parameters here are very similar to the json body formatting except that the filter syntax is tricky. Unfortunately, this format makes this method not currently callible via the &#39;Try it out!&#39; button in this documentation page. But, this is callable when creating URLs manually or when using the Looker SDK. Here is an example inline query URL: &#x60;&#x60;&#x60; https://looker.mycompany.com:19999/api/3.0/queries/models/thelook/views/inventory_items/run/json?fields&#x3D;category.name,inventory_items.days_in_inventory_tier,products.count&amp;f[category.name]&#x3D;socks&amp;sorts&#x3D;products.count+desc+0&amp;limit&#x3D;500&amp;query_timezone&#x3D;America/Los_Angeles &#x60;&#x60;&#x60; When invoking this endpoint with the Ruby SDK, pass the query parameter parts as a hash. The hash to match the above would look like: &#x60;&#x60;&#x60;ruby query_params &#x3D; { :fields &#x3D;&gt; \&quot;category.name,inventory_items.days_in_inventory_tier,products.count\&quot;, :\&quot;f[category.name]\&quot; &#x3D;&gt; \&quot;socks\&quot;, :sorts &#x3D;&gt; \&quot;products.count desc 0\&quot;, :limit &#x3D;&gt; \&quot;500\&quot;, :query_timezone &#x3D;&gt; \&quot;America/Los_Angeles\&quot; } response &#x3D; ruby_sdk.run_url_encoded_query(&#39;thelook&#39;,&#39;inventory_items&#39;,&#39;json&#39;, query_params) &#x60;&#x60;&#x60; Again, it is generally easier to use the variant of this method that passes the full query in the POST body. This method is available for cases where other alternatives won&#39;t fit the need. Supported formats: | result_format | Description | :-----------: | :--- | | json | Plain json | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | md | Simple markdown | xlsx | MS Excel spreadsheet | sql | Returns the generated SQL rather than running the query | png | A PNG image of the visualization of the query | jpg | A JPG image of the visualization of the query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param modelName Model name
  • @param viewName View name
  • @param resultFormat Format of result

@return string

func (*QueryApiService) SqlQuery 

func (a *QueryApiService) SqlQuery(ctx _context.Context, slug string) (SqlQuery, *_nethttp.Response, error)

SqlQuery Get SQL Runner Query Get a SQL Runner query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param slug slug of query

@return SqlQuery

type QueryForSlugOpts 

type QueryForSlugOpts struct {
	Fields optional.String
}

QueryForSlugOpts Optional parameters for the method 'QueryForSlug'

type QueryOpts 

type QueryOpts struct {
	Fields optional.String
}

QueryOpts Optional parameters for the method 'Query'

type QueryTask 

type QueryTask struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of query
	QueryId int64 `json:"query_id,omitempty"`
	Query   Query `json:"query,omitempty"`
	// whether or not to generate links in the query response.
	GenerateLinks bool `json:"generate_links,omitempty"`
	// Use production models to run query (even is user is in dev mode).
	ForceProduction bool `json:"force_production,omitempty"`
	// Prefix to use for drill links.
	PathPrefix string `json:"path_prefix,omitempty"`
	// Whether or not to use the cache
	Cache bool `json:"cache,omitempty"`
	// Whether or not to run table calculations on the server
	ServerTableCalcs bool `json:"server_table_calcs,omitempty"`
	// Retrieve any results from cache even if the results have expired.
	CacheOnly bool `json:"cache_only,omitempty"`
	// cache key used to cache query.
	CacheKey string `json:"cache_key,omitempty"`
	// Status of query task.
	Status string `json:"status,omitempty"`
	// Source of query task.
	Source string `json:"source,omitempty"`
	// Runtime of prior queries.
	Runtime float32 `json:"runtime,omitempty"`
	// Rebuild PDTS used in query.
	RebuildPdts bool `json:"rebuild_pdts,omitempty"`
	// Source of the results of the query.
	ResultSource string `json:"result_source,omitempty"`
	// Id of look associated with query.
	LookId int64 `json:"look_id,omitempty"`
	// Id of dashboard associated with query.
	DashboardId string `json:"dashboard_id,omitempty"`
	// The data format of the query results.
	ResultFormat string `json:"result_format,omitempty"`
}

QueryTask struct for QueryTask

type QueryTaskOpts 

type QueryTaskOpts struct {
	Fields optional.String
}

QueryTaskOpts Optional parameters for the method 'QueryTask'

type RenderTask 

type RenderTask struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Date/Time render task was created
	CreatedAt string `json:"created_at,omitempty"`
	// Filter values to apply to the dashboard queries, in URL query format
	DashboardFilters string `json:"dashboard_filters,omitempty"`
	// Id of dashboard to render
	DashboardId int64 `json:"dashboard_id,omitempty"`
	// Dashboard layout style: single_column or tiled
	DashboardStyle string `json:"dashboard_style,omitempty"`
	// Date/Time render task was completed
	FinalizedAt string `json:"finalized_at,omitempty"`
	// Output height in pixels. Flowed layouts may ignore this value.
	Height int64 `json:"height,omitempty"`
	// Id of this render task
	Id string `json:"id,omitempty"`
	// Id of look to render
	LookId int64 `json:"look_id,omitempty"`
	// Id of lookml dashboard to render
	LookmlDashboardId string `json:"lookml_dashboard_id,omitempty"`
	// Id of query to render
	QueryId int64 `json:"query_id,omitempty"`
	// Number of seconds elapsed running queries
	QueryRuntime float64 `json:"query_runtime,omitempty"`
	// Number of seconds elapsed rendering data
	RenderRuntime float64 `json:"render_runtime,omitempty"`
	// Output format: pdf, png, or jpg
	ResultFormat string `json:"result_format,omitempty"`
	// Total seconds elapsed for render task
	Runtime float64 `json:"runtime,omitempty"`
	// Render task status: enqueued_for_query, querying, enqueued_for_render, rendering, success, failure
	Status string `json:"status,omitempty"`
	// Additional information about the current status
	StatusDetail string `json:"status_detail,omitempty"`
	// The user account permissions in which the render task will execute
	UserId int64 `json:"user_id,omitempty"`
	// Output width in pixels
	Width int64 `json:"width,omitempty"`
}

RenderTask struct for RenderTask

type RenderTaskApiService 

type RenderTaskApiService service

RenderTaskApiService RenderTaskApi service

func (*RenderTaskApiService) CreateDashboardRenderTask 

func (a *RenderTaskApiService) CreateDashboardRenderTask(ctx _context.Context, dashboardId int64, resultFormat string, width int64, height int64, body CreateDashboardRenderTask, localVarOptionals *CreateDashboardRenderTaskOpts) (RenderTask, *_nethttp.Response, error)

CreateDashboardRenderTask Create Dashboard Render Task ### Create a new task to render a dashboard to a document or image. Returns a render task object. To check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task). Once the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of dashboard to render
  • @param resultFormat Output type: pdf, png, or jpg
  • @param width Output width in pixels
  • @param height Output height in pixels
  • @param body Dashboard render task parameters
  • @param optional nil or *CreateDashboardRenderTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "PdfPaperSize" (optional.String) - Paper size for pdf
  • @param "PdfLandscape" (optional.Bool) - Whether to render pdf in landscape

@return RenderTask

func (*RenderTaskApiService) CreateLookRenderTask 

func (a *RenderTaskApiService) CreateLookRenderTask(ctx _context.Context, lookId int64, resultFormat string, width int64, height int64, localVarOptionals *CreateLookRenderTaskOpts) (RenderTask, *_nethttp.Response, error)

CreateLookRenderTask Create Look Render Task ### Create a new task to render a look to an image. Returns a render task object. To check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task). Once the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Id of look to render
  • @param resultFormat Output type: png, or jpg
  • @param width Output width in pixels
  • @param height Output height in pixels
  • @param optional nil or *CreateLookRenderTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return RenderTask

func (*RenderTaskApiService) CreateLookmlDashboardRenderTask 

func (a *RenderTaskApiService) CreateLookmlDashboardRenderTask(ctx _context.Context, dashboardId string, resultFormat string, width int64, height int64, body CreateDashboardRenderTask, localVarOptionals *CreateLookmlDashboardRenderTaskOpts) (RenderTask, *_nethttp.Response, error)

CreateLookmlDashboardRenderTask Create Lookml Dashboard Render Task ### Create a new task to render a lookml dashboard to a document or image. Returns a render task object. To check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task). Once the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Id of lookml dashboard to render
  • @param resultFormat Output type: pdf, png, or jpg
  • @param width Output width in pixels
  • @param height Output height in pixels
  • @param body Dashboard render task parameters
  • @param optional nil or *CreateLookmlDashboardRenderTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "PdfPaperSize" (optional.String) - Paper size for pdf
  • @param "PdfLandscape" (optional.Bool) - Whether to render pdf in landscape

@return RenderTask

func (*RenderTaskApiService) CreateQueryRenderTask 

func (a *RenderTaskApiService) CreateQueryRenderTask(ctx _context.Context, queryId int64, resultFormat string, width int64, height int64, localVarOptionals *CreateQueryRenderTaskOpts) (RenderTask, *_nethttp.Response, error)

CreateQueryRenderTask Create Query Render Task ### Create a new task to render an existing query to an image. Returns a render task object. To check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task). Once the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queryId Id of the query to render
  • @param resultFormat Output type: png or jpg
  • @param width Output width in pixels
  • @param height Output height in pixels
  • @param optional nil or *CreateQueryRenderTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return RenderTask

func (*RenderTaskApiService) RenderTask 

func (a *RenderTaskApiService) RenderTask(ctx _context.Context, renderTaskId string, localVarOptionals *RenderTaskOpts) (RenderTask, *_nethttp.Response, error)

RenderTask Get Render Task ### Get information about a render task. Returns a render task object. To check the status of a render task, pass the render_task.id to [Get Render Task](#!/RenderTask/get_render_task). Once the render task is complete, you can download the resulting document or image using [Get Render Task Results](#!/RenderTask/get_render_task_results).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param renderTaskId Id of render task
  • @param optional nil or *RenderTaskOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return RenderTask

func (*RenderTaskApiService) RenderTaskResults 

func (a *RenderTaskApiService) RenderTaskResults(ctx _context.Context, renderTaskId string) (string, *_nethttp.Response, error)

RenderTaskResults Render Task Results ### Get the document or image produced by a completed render task. Note that the PDF or image result will be a binary blob in the HTTP response, as indicated by the Content-Type in the response headers. This may require specialized (or at least different) handling than text responses such as JSON. You may need to tell your HTTP client that the response is binary so that it does not attempt to parse the binary data as text. If the render task exists but has not finished rendering the results, the response HTTP status will be **202 Accepted**, the response body will be empty, and the response will have a Retry-After header indicating that the caller should repeat the request at a later time. Returns 404 if the render task cannot be found, if the cached result has expired, or if the caller does not have permission to view the results. For detailed information about the status of the render task, use [Render Task](#!/RenderTask/render_task). Polling loops waiting for completion of a render task would be better served by polling **render_task(id)** until the task status reaches completion (or error) instead of polling **render_task_results(id)** alone.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param renderTaskId Id of render task

@return string

type RenderTaskOpts 

type RenderTaskOpts struct {
	Fields optional.String
}

RenderTaskOpts Optional parameters for the method 'RenderTask'

type RepositoryCredential 

type RepositoryCredential struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Root project Id
	RootProjectId string `json:"root_project_id,omitempty"`
	// Git remote repository url
	RemoteUrl string `json:"remote_url,omitempty"`
	// Git username for HTTPS authentication.
	GitUsername string `json:"git_username,omitempty"`
	// (Write-Only) Git password for HTTPS authentication.
	GitPassword string `json:"git_password,omitempty"`
	// Public deploy key for SSH authentication.
	SshPublicKey string `json:"ssh_public_key,omitempty"`
	// Whether the credentials have been configured for the Git Repository.
	IsConfigured bool `json:"is_configured,omitempty"`
}

RepositoryCredential struct for RepositoryCredential

type ResultMakerFilterables 

type ResultMakerFilterables struct {
	// The model this filterable comes from (used for field suggestions).
	Model string `json:"model,omitempty"`
	// The view this filterable comes from (used for field suggestions).
	View string `json:"view,omitempty"`
	// The name of the filterable thing (Query or Merged Results).
	Name string `json:"name,omitempty"`
	// array of dashboard_filter_name: and field: objects.
	Listen []ResultMakerFilterablesListen `json:"listen,omitempty"`
}

ResultMakerFilterables struct for ResultMakerFilterables

type ResultMakerFilterablesListen 

type ResultMakerFilterablesListen struct {
	// The name of a dashboard filter to listen to.
	DashboardFilterName string `json:"dashboard_filter_name,omitempty"`
	// The name of the field in the filterable to filter with the value of the dashboard filter.
	Field string `json:"field,omitempty"`
}

ResultMakerFilterablesListen struct for ResultMakerFilterablesListen

type ResultMakerWithIdVisConfigAndDynamicFields 

type ResultMakerWithIdVisConfigAndDynamicFields struct {
	// Unique Id.
	Id int64 `json:"id,omitempty"`
	// JSON string of dynamic field information.
	DynamicFields string `json:"dynamic_fields,omitempty"`
	// array of items that can be filtered and information about them.
	Filterables []ResultMakerFilterables `json:"filterables,omitempty"`
	// Sorts of the constituent Look, Query, or Merge Query
	Sorts []string `json:"sorts,omitempty"`
	// ID of merge result if this is a merge_result.
	MergeResultId string `json:"merge_result_id,omitempty"`
	// Total of the constituent Look, Query, or Merge Query
	Total bool `json:"total,omitempty"`
	// ID of query if this is a query.
	QueryId int64 `json:"query_id,omitempty"`
	Query   Query `json:"query,omitempty"`
	// Vis config of the constituent Query, or Merge Query.
	VisConfig map[string]string `json:"vis_config,omitempty"`
}

ResultMakerWithIdVisConfigAndDynamicFields struct for ResultMakerWithIdVisConfigAndDynamicFields

type Role 

type Role struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Name of Role
	Name          string        `json:"name,omitempty"`
	PermissionSet PermissionSet `json:"permission_set,omitempty"`
	// (Write-Only) Id of permission set
	PermissionSetId int64    `json:"permission_set_id,omitempty"`
	ModelSet        ModelSet `json:"model_set,omitempty"`
	// (Write-Only) Id of model set
	ModelSetId int64 `json:"model_set_id,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
	// Link to get list of users with this role
	UsersUrl string `json:"users_url,omitempty"`
}

Role struct for Role

type RoleApiService 

type RoleApiService service

RoleApiService RoleApi service

func (*RoleApiService) AllModelSets 

func (a *RoleApiService) AllModelSets(ctx _context.Context, localVarOptionals *AllModelSetsOpts) ([]ModelSet, *_nethttp.Response, error)

AllModelSets Get All Model Sets ### Get information about all model sets.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllModelSetsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ModelSet

func (*RoleApiService) AllPermissionSets 

func (a *RoleApiService) AllPermissionSets(ctx _context.Context, localVarOptionals *AllPermissionSetsOpts) ([]PermissionSet, *_nethttp.Response, error)

AllPermissionSets Get All Permission Sets ### Get information about all permission sets.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllPermissionSetsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []PermissionSet

func (*RoleApiService) AllPermissions 

func (a *RoleApiService) AllPermissions(ctx _context.Context) ([]Permission, *_nethttp.Response, error)

AllPermissions Get All Permissions ### Get all supported permissions.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Permission

func (*RoleApiService) AllRoles 

func (a *RoleApiService) AllRoles(ctx _context.Context, localVarOptionals *AllRolesOpts) ([]Role, *_nethttp.Response, error)

AllRoles Get All Roles ### Get information about all roles.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllRolesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Ids" (optional.Interface of []int64) - Optional list of ids to get specific roles.

@return []Role

func (*RoleApiService) CreateModelSet 

func (a *RoleApiService) CreateModelSet(ctx _context.Context, body ModelSet) (ModelSet, *_nethttp.Response, error)

CreateModelSet Create Model Set ### Create a model set with the specified information. Model sets are used by Roles.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body ModelSet

@return ModelSet

func (*RoleApiService) CreatePermissionSet 

func (a *RoleApiService) CreatePermissionSet(ctx _context.Context, body PermissionSet) (PermissionSet, *_nethttp.Response, error)

CreatePermissionSet Create Permission Set ### Create a permission set with the specified information. Permission sets are used by Roles.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Permission Set

@return PermissionSet

func (*RoleApiService) CreateRole 

func (a *RoleApiService) CreateRole(ctx _context.Context, body Role) (Role, *_nethttp.Response, error)

CreateRole Create Role ### Create a role with the specified information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Role

@return Role

func (*RoleApiService) DeleteModelSet 

func (a *RoleApiService) DeleteModelSet(ctx _context.Context, modelSetId int64) (string, *_nethttp.Response, error)

DeleteModelSet Delete Model Set ### Delete the model set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param modelSetId id of model set

@return string

func (*RoleApiService) DeletePermissionSet 

func (a *RoleApiService) DeletePermissionSet(ctx _context.Context, permissionSetId int64) (string, *_nethttp.Response, error)

DeletePermissionSet Delete Permission Set ### Delete the permission set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param permissionSetId Id of permission set

@return string

func (*RoleApiService) DeleteRole 

func (a *RoleApiService) DeleteRole(ctx _context.Context, roleId int64) (string, *_nethttp.Response, error)

DeleteRole Delete Role ### Delete the role with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of role

@return string

func (*RoleApiService) ModelSet 

func (a *RoleApiService) ModelSet(ctx _context.Context, modelSetId int64, localVarOptionals *ModelSetOpts) (ModelSet, *_nethttp.Response, error)

ModelSet Get Model Set ### Get information about the model set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param modelSetId Id of model set
  • @param optional nil or *ModelSetOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ModelSet

func (*RoleApiService) PermissionSet 

func (a *RoleApiService) PermissionSet(ctx _context.Context, permissionSetId int64, localVarOptionals *PermissionSetOpts) (PermissionSet, *_nethttp.Response, error)

PermissionSet Get Permission Set ### Get information about the permission set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param permissionSetId Id of permission set
  • @param optional nil or *PermissionSetOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return PermissionSet

func (*RoleApiService) Role 

func (a *RoleApiService) Role(ctx _context.Context, roleId int64) (Role, *_nethttp.Response, error)

Role Get Role ### Get information about the role with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of role

@return Role

func (*RoleApiService) RoleGroups 

func (a *RoleApiService) RoleGroups(ctx _context.Context, roleId int64, localVarOptionals *RoleGroupsOpts) ([]Group, *_nethttp.Response, error)

RoleGroups Get Role Groups ### Get information about all the groups with the role that has a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of role
  • @param optional nil or *RoleGroupsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Group

func (*RoleApiService) RoleUsers 

func (a *RoleApiService) RoleUsers(ctx _context.Context, roleId int64, localVarOptionals *RoleUsersOpts) ([]User, *_nethttp.Response, error)

RoleUsers Get Role Users ### Get information about all the users with the role that has a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of user
  • @param optional nil or *RoleUsersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "DirectAssociationOnly" (optional.Bool) - Get only users associated directly with the role: exclude those only associated through groups.

@return []User

func (*RoleApiService) SearchModelSets 

func (a *RoleApiService) SearchModelSets(ctx _context.Context, localVarOptionals *SearchModelSetsOpts) ([]ModelSet, *_nethttp.Response, error)

SearchModelSets Search Model Sets ### Search model sets Returns all model set records that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchModelSetsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Limit" (optional.Int64) - Number of results to return (used with `offset`).
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any (used with `limit`).
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Id" (optional.Int64) - Match model set id.
  • @param "Name" (optional.String) - Match model set name.
  • @param "AllAccess" (optional.Bool) - Match model sets by all_access status.
  • @param "BuiltIn" (optional.Bool) - Match model sets by built_in status.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression.

@return []ModelSet

func (*RoleApiService) SearchPermissionSets 

func (a *RoleApiService) SearchPermissionSets(ctx _context.Context, localVarOptionals *SearchPermissionSetsOpts) ([]PermissionSet, *_nethttp.Response, error)

SearchPermissionSets Search Permission Sets ### Search permission sets Returns all permission set records that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchPermissionSetsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Limit" (optional.Int64) - Number of results to return (used with `offset`).
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any (used with `limit`).
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Id" (optional.Int64) - Match permission set id.
  • @param "Name" (optional.String) - Match permission set name.
  • @param "AllAccess" (optional.Bool) - Match permission sets by all_access status.
  • @param "BuiltIn" (optional.Bool) - Match permission sets by built_in status.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression.

@return []PermissionSet

func (*RoleApiService) SearchRoles 

func (a *RoleApiService) SearchRoles(ctx _context.Context, localVarOptionals *SearchRolesOpts) ([]Role, *_nethttp.Response, error)

SearchRoles Search Roles ### Search roles Returns all role records that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchRolesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Limit" (optional.Int64) - Number of results to return (used with `offset`).
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any (used with `limit`).
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Id" (optional.Int64) - Match role id.
  • @param "Name" (optional.String) - Match role name.
  • @param "BuiltIn" (optional.Bool) - Match roles by built_in status.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression.

@return []Role

func (*RoleApiService) SetRoleGroups 

func (a *RoleApiService) SetRoleGroups(ctx _context.Context, roleId int64, body []int64) ([]Group, *_nethttp.Response, error)

SetRoleGroups Update Role Groups ### Set all groups for a role, removing all existing group associations from that role.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId Id of Role
  • @param body Array of Group Ids

@return []Group

func (*RoleApiService) SetRoleUsers 

func (a *RoleApiService) SetRoleUsers(ctx _context.Context, roleId int64, body []int64) ([]User, *_nethttp.Response, error)

SetRoleUsers Update Role Users ### Set all the users of the role with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of role
  • @param body array of user ids for role

@return []User

func (*RoleApiService) UpdateModelSet 

func (a *RoleApiService) UpdateModelSet(ctx _context.Context, modelSetId int64, body ModelSet) (ModelSet, *_nethttp.Response, error)

UpdateModelSet Update Model Set ### Update information about the model set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param modelSetId id of model set
  • @param body ModelSet

@return ModelSet

func (*RoleApiService) UpdatePermissionSet 

func (a *RoleApiService) UpdatePermissionSet(ctx _context.Context, permissionSetId int64, body PermissionSet) (PermissionSet, *_nethttp.Response, error)

UpdatePermissionSet Update Permission Set ### Update information about the permission set with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param permissionSetId id of permission set
  • @param body Permission Set

@return PermissionSet

func (*RoleApiService) UpdateRole 

func (a *RoleApiService) UpdateRole(ctx _context.Context, roleId int64, body Role) (Role, *_nethttp.Response, error)

UpdateRole Update Role ### Update information about the role with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId id of role
  • @param body Role

@return Role

type RoleGroupsOpts 

type RoleGroupsOpts struct {
	Fields optional.String
}

RoleGroupsOpts Optional parameters for the method 'RoleGroups'

type RoleUsersOpts 

type RoleUsersOpts struct {
	Fields                optional.String
	DirectAssociationOnly optional.Bool
}

RoleUsersOpts Optional parameters for the method 'RoleUsers'

type RunGitConnectionTestOpts 

type RunGitConnectionTestOpts struct {
	RemoteUrl optional.String
}

RunGitConnectionTestOpts Optional parameters for the method 'RunGitConnectionTest'

type RunInlineQueryOpts 

type RunInlineQueryOpts struct {
	Limit              optional.Int64
	ApplyFormatting    optional.Bool
	ApplyVis           optional.Bool
	Cache              optional.Bool
	ImageWidth         optional.Int64
	ImageHeight        optional.Int64
	GenerateDrillLinks optional.Bool
	ForceProduction    optional.Bool
	CacheOnly          optional.Bool
	PathPrefix         optional.String
	RebuildPdts        optional.Bool
	ServerTableCalcs   optional.Bool
}

RunInlineQueryOpts Optional parameters for the method 'RunInlineQuery'

type RunLookOpts 

type RunLookOpts struct {
	Limit              optional.Int64
	ApplyFormatting    optional.Bool
	ApplyVis           optional.Bool
	Cache              optional.Bool
	ImageWidth         optional.Int64
	ImageHeight        optional.Int64
	GenerateDrillLinks optional.Bool
	ForceProduction    optional.Bool
	CacheOnly          optional.Bool
	PathPrefix         optional.String
	RebuildPdts        optional.Bool
	ServerTableCalcs   optional.Bool
}

RunLookOpts Optional parameters for the method 'RunLook'

type RunLookmlTestOpts 

type RunLookmlTestOpts struct {
	FileId optional.String
	Test   optional.String
	Model  optional.String
}

RunLookmlTestOpts Optional parameters for the method 'RunLookmlTest'

type RunQueryOpts 

type RunQueryOpts struct {
	Limit              optional.Int64
	ApplyFormatting    optional.Bool
	ApplyVis           optional.Bool
	Cache              optional.Bool
	ImageWidth         optional.Int64
	ImageHeight        optional.Int64
	GenerateDrillLinks optional.Bool
	ForceProduction    optional.Bool
	CacheOnly          optional.Bool
	PathPrefix         optional.String
	RebuildPdts        optional.Bool
	ServerTableCalcs   optional.Bool
}

RunQueryOpts Optional parameters for the method 'RunQuery'

type RunSqlQueryOpts 

type RunSqlQueryOpts struct {
	Download optional.String
}

RunSqlQueryOpts Optional parameters for the method 'RunSqlQuery'

type RunningQueries 

type RunningQueries struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id       int64      `json:"id,omitempty"`
	User     UserPublic `json:"user,omitempty"`
	Query    Query      `json:"query,omitempty"`
	SqlQuery SqlQuery   `json:"sql_query,omitempty"`
	Look     LookBasic  `json:"look,omitempty"`
	// Date/Time Query was initiated
	CreatedAt string `json:"created_at,omitempty"`
	// Date/Time Query was completed
	CompletedAt string `json:"completed_at,omitempty"`
	// Query Id
	QueryId string `json:"query_id,omitempty"`
	// Source (look, dashboard, queryrunner, explore, etc.)
	Source string `json:"source,omitempty"`
	// Node Id
	NodeId string `json:"node_id,omitempty"`
	// Slug
	Slug string `json:"slug,omitempty"`
	// ID of a Query Task
	QueryTaskId string `json:"query_task_id,omitempty"`
	// Cache Key
	CacheKey string `json:"cache_key,omitempty"`
	// Connection
	ConnectionName string `json:"connection_name,omitempty"`
	// Dialect
	Dialect string `json:"dialect,omitempty"`
	// Connection ID
	ConnectionId string `json:"connection_id,omitempty"`
	// Additional Information(Error message or verbose status)
	Message string `json:"message,omitempty"`
	// Status description
	Status string `json:"status,omitempty"`
	// Number of seconds elapsed running the Query
	Runtime float64 `json:"runtime,omitempty"`
	// SQL text of the query as run
	Sql string `json:"sql,omitempty"`
}

RunningQueries struct for RunningQueries

type SamlConfig 

type SamlConfig struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Enable/Disable Saml authentication for the server
	Enabled bool `json:"enabled,omitempty"`
	// Identity Provider Certificate (provided by IdP)
	IdpCert string `json:"idp_cert,omitempty"`
	// Identity Provider Url (provided by IdP)
	IdpUrl string `json:"idp_url,omitempty"`
	// Identity Provider Issuer (provided by IdP)
	IdpIssuer string `json:"idp_issuer,omitempty"`
	// Identity Provider Audience (set in IdP config). Optional in Looker. Set this only if you want Looker to validate the audience value returned by the IdP.
	IdpAudience string `json:"idp_audience,omitempty"`
	// Count of seconds of clock drift to allow when validating timestamps of assertions.
	AllowedClockDrift int64 `json:"allowed_clock_drift,omitempty"`
	// Name of user record attributes used to indicate email address field
	UserAttributeMapEmail string `json:"user_attribute_map_email,omitempty"`
	// Name of user record attributes used to indicate first name
	UserAttributeMapFirstName string `json:"user_attribute_map_first_name,omitempty"`
	// Name of user record attributes used to indicate last name
	UserAttributeMapLastName string `json:"user_attribute_map_last_name,omitempty"`
	// Merge first-time saml login to existing user account by email addresses. When a user logs in for the first time via saml this option will connect this user into their existing account by finding the account with a matching email address by testing the given types of credentials for existing users. Otherwise a new user account will be created for the user. This list (if provided) must be a comma separated list of string like 'email,ldap,google'
	NewUserMigrationTypes string `json:"new_user_migration_types,omitempty"`
	// Allow alternate email-based login via '/login/email' for admins and for specified users with the 'login_special_email' permission. This option is useful as a fallback during ldap setup, if ldap config problems occur later, or if you need to support some users who are not in your ldap directory. Looker email/password logins are always disabled for regular users when ldap is enabled.
	AlternateEmailLoginAllowed bool `json:"alternate_email_login_allowed,omitempty"`
	// Slug to identify configurations that are created in order to run a Saml config test
	TestSlug string `json:"test_slug,omitempty"`
	// When this config was last modified
	ModifiedAt string `json:"modified_at,omitempty"`
	// User id of user who last modified this config
	ModifiedBy string `json:"modified_by,omitempty"`
	// (Read-only) Roles that will be applied to new users the first time they login via Saml
	DefaultNewUserRoles []Role `json:"default_new_user_roles,omitempty"`
	// (Read-only) Groups that will be applied to new users the first time they login via Saml
	DefaultNewUserGroups []Group `json:"default_new_user_groups,omitempty"`
	// (Write-Only) Array of ids of roles that will be applied to new users the first time they login via Saml
	DefaultNewUserRoleIds []int64 `json:"default_new_user_role_ids,omitempty"`
	// (Write-Only) Array of ids of groups that will be applied to new users the first time they login via Saml
	DefaultNewUserGroupIds []int64 `json:"default_new_user_group_ids,omitempty"`
	// Set user roles in Looker based on groups from Saml
	SetRolesFromGroups bool `json:"set_roles_from_groups,omitempty"`
	// Name of user record attributes used to indicate groups. Used when 'groups_finder_type' is set to 'grouped_attribute_values'
	GroupsAttribute string `json:"groups_attribute,omitempty"`
	// (Read-only) Array of mappings between Saml Groups and Looker Roles
	Groups []SamlGroupRead `json:"groups,omitempty"`
	// (Read/Write) Array of mappings between Saml Groups and arrays of Looker Role ids
	GroupsWithRoleIds []SamlGroupWrite `json:"groups_with_role_ids,omitempty"`
	// Users will not be allowed to login at all unless a role for them is found in Saml if set to true
	AuthRequiresRole bool `json:"auth_requires_role,omitempty"`
	// (Read-only) Array of mappings between Saml User Attributes and Looker User Attributes
	UserAttributes []SamlUserAttributeRead `json:"user_attributes,omitempty"`
	// (Read/Write) Array of mappings between Saml User Attributes and arrays of Looker User Attribute ids
	UserAttributesWithIds []SamlUserAttributeWrite `json:"user_attributes_with_ids,omitempty"`
	// Identifier for a strategy for how Looker will find groups in the SAML response. One of ['grouped_attribute_values', 'individual_attributes']
	GroupsFinderType string `json:"groups_finder_type,omitempty"`
	// Value for group attribute used to indicate membership. Used when 'groups_finder_type' is set to 'individual_attributes'
	GroupsMemberValue string `json:"groups_member_value,omitempty"`
	// Bypass the login page when user authentication is required. Redirect to IdP immediately instead.
	BypassLoginPage bool `json:"bypass_login_page,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

SamlConfig struct for SamlConfig

type SamlGroupRead 

type SamlGroupRead struct {
	// Name of group in Saml
	Name string `json:"name,omitempty"`
	// Looker Roles
	Roles []Role `json:"roles,omitempty"`
	// Link to saml config
	Url string `json:"url,omitempty"`
}

SamlGroupRead struct for SamlGroupRead

type SamlGroupWrite 

type SamlGroupWrite struct {
	// Name of group in Saml
	Name string `json:"name,omitempty"`
	// Looker Role Ids
	RoleIds []int64 `json:"role_ids,omitempty"`
	// Link to saml config
	Url string `json:"url,omitempty"`
}

SamlGroupWrite struct for SamlGroupWrite

type SamlMetadataParseResult 

type SamlMetadataParseResult struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Identify Provider Issuer
	IdpIssuer string `json:"idp_issuer,omitempty"`
	// Identify Provider Url
	IdpUrl string `json:"idp_url,omitempty"`
	// Identify Provider Certificate
	IdpCert string `json:"idp_cert,omitempty"`
}

SamlMetadataParseResult struct for SamlMetadataParseResult

type SamlUserAttributeRead 

type SamlUserAttributeRead struct {
	// Name of User Attribute in Saml
	Name string `json:"name,omitempty"`
	// Required to be in Saml assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attributes
	UserAttributes []UserAttribute `json:"user_attributes,omitempty"`
	// Link to saml config
	Url string `json:"url,omitempty"`
}

SamlUserAttributeRead struct for SamlUserAttributeRead

type SamlUserAttributeWrite 

type SamlUserAttributeWrite struct {
	// Name of User Attribute in Saml
	Name string `json:"name,omitempty"`
	// Required to be in Saml assertion for login to be allowed to succeed
	Required bool `json:"required,omitempty"`
	// Looker User Attribute Ids
	UserAttributeIds []int64 `json:"user_attribute_ids,omitempty"`
	// Link to saml config
	Url string `json:"url,omitempty"`
}

SamlUserAttributeWrite struct for SamlUserAttributeWrite

type ScheduledPlan 

type ScheduledPlan struct {
	// Name of this scheduled plan
	Name string `json:"name,omitempty"`
	// User Id which owns this scheduled plan
	UserId int64 `json:"user_id,omitempty"`
	// Whether schedule is run as recipient (only applicable for email recipients)
	RunAsRecipient bool `json:"run_as_recipient,omitempty"`
	// Whether the ScheduledPlan is enabled
	Enabled bool `json:"enabled,omitempty"`
	// Id of a look
	LookId int64 `json:"look_id,omitempty"`
	// Id of a dashboard
	DashboardId int64 `json:"dashboard_id,omitempty"`
	// Id of a LookML dashboard
	LookmlDashboardId string `json:"lookml_dashboard_id,omitempty"`
	// Query string to run look or dashboard with
	FiltersString string `json:"filters_string,omitempty"`
	// (DEPRECATED) Alias for filters_string field
	DashboardFilters string `json:"dashboard_filters,omitempty"`
	// Delivery should occur if running the dashboard or look returns results
	RequireResults bool `json:"require_results,omitempty"`
	// Delivery should occur if the dashboard look does not return results
	RequireNoResults bool `json:"require_no_results,omitempty"`
	// Delivery should occur if data have changed since the last run
	RequireChange bool `json:"require_change,omitempty"`
	// Will run an unlimited query and send all results.
	SendAllResults bool `json:"send_all_results,omitempty"`
	// Vixie-Style crontab specification when to run
	Crontab string `json:"crontab,omitempty"`
	// Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string)
	Datagroup string `json:"datagroup,omitempty"`
	// Timezone for interpreting the specified crontab (default is Looker instance timezone)
	Timezone string `json:"timezone,omitempty"`
	// Query id
	QueryId string `json:"query_id,omitempty"`
	// Scheduled plan destinations
	ScheduledPlanDestination []ScheduledPlanDestination `json:"scheduled_plan_destination,omitempty"`
	// Whether the plan in question should only be run once (usually for testing)
	RunOnce bool `json:"run_once,omitempty"`
	// Whether links back to Looker should be included in this ScheduledPlan
	IncludeLinks bool `json:"include_links,omitempty"`
	// The size of paper a PDF should be rendered for
	PdfPaperSize string `json:"pdf_paper_size,omitempty"`
	// Whether the paper should be landscape
	PdfLandscape bool `json:"pdf_landscape,omitempty"`
	// Whether this schedule is in an embed context or not
	Embed bool `json:"embed,omitempty"`
	// Color scheme of the dashboard if applicable
	ColorTheme string `json:"color_theme,omitempty"`
	// Whether or not to expand table vis to full length
	LongTables bool `json:"long_tables,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Date and time when ScheduledPlan was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Date and time when ScheduledPlan was last updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Title
	Title string     `json:"title,omitempty"`
	User  UserPublic `json:"user,omitempty"`
	// When the ScheduledPlan will next run (null if running once)
	NextRunAt time.Time `json:"next_run_at,omitempty"`
	// When the ScheduledPlan was last run
	LastRunAt time.Time `json:"last_run_at,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

ScheduledPlan struct for ScheduledPlan

type ScheduledPlanApiService 

type ScheduledPlanApiService service

ScheduledPlanApiService ScheduledPlanApi service

func (*ScheduledPlanApiService) AllScheduledPlans 

func (a *ScheduledPlanApiService) AllScheduledPlans(ctx _context.Context, localVarOptionals *AllScheduledPlansOpts) ([]ScheduledPlan, *_nethttp.Response, error)

AllScheduledPlans Get All Scheduled Plans ### List All Scheduled Plans Returns all scheduled plans which belong to the caller or given user. If no user_id is provided, this function returns the scheduled plans owned by the caller. To list all schedules for all users, pass &#x60;all_users&#x3D;true&#x60;. The caller must have &#x60;see_schedules&#x60; permission to see other users&#39; scheduled plans.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllScheduledPlansOpts - Optional Parameters:
  • @param "UserId" (optional.Int64) - Return scheduled plans belonging to this user_id. If not provided, returns scheduled plans owned by the caller.
  • @param "Fields" (optional.String) - Comma delimited list of field names. If provided, only the fields specified will be included in the response
  • @param "AllUsers" (optional.Bool) - Return scheduled plans belonging to all users (caller needs see_schedules permission)

@return []ScheduledPlan

func (*ScheduledPlanApiService) CreateScheduledPlan 

func (a *ScheduledPlanApiService) CreateScheduledPlan(ctx _context.Context, body ScheduledPlan) (ScheduledPlan, *_nethttp.Response, error)

CreateScheduledPlan Create Scheduled Plan ### Create a Scheduled Plan Create a scheduled plan to render a Look or Dashboard on a recurring schedule. To create a scheduled plan, you MUST provide values for the following fields: &#x60;name&#x60; and &#x60;look_id&#x60;, &#x60;dashboard_id&#x60;, &#x60;lookml_dashboard_id&#x60;, or &#x60;query_id&#x60; and &#x60;cron_tab&#x60; or &#x60;datagroup&#x60; and at least one scheduled_plan_destination A scheduled plan MUST have at least one scheduled_plan_destination defined. When &#x60;look_id&#x60; is set, &#x60;require_no_results&#x60;, &#x60;require_results&#x60;, and &#x60;require_change&#x60; are all required. If &#x60;create_scheduled_plan&#x60; fails with a 422 error, be sure to look at the error messages in the response which will explain exactly what fields are missing or values that are incompatible. The queries that provide the data for the look or dashboard are run in the context of user account that owns the scheduled plan. When &#x60;run_as_recipient&#x60; is &#x60;false&#x60; or not specified, the queries that provide the data for the look or dashboard are run in the context of user account that owns the scheduled plan. When &#x60;run_as_recipient&#x60; is &#x60;true&#x60; and all the email recipients are Looker user accounts, the queries are run in the context of each recipient, so different recipients may see different data from the same scheduled render of a look or dashboard. For more details, see [Run As Recipient](https://looker.com/docs/r/admin/run-as-recipient). Admins can create and modify scheduled plans on behalf of other users by specifying a user id. Non-admin users may not create or modify scheduled plans by or for other users. #### Email Permissions: For details about permissions required to schedule delivery to email and the safeguards Looker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions). #### Scheduled Plan Destination Formats Scheduled plan destinations must specify the data format to produce and send to the destination. Formats: | format | Description | :-----------: | :--- | | json | A JSON object containing a &#x60;data&#x60; property which contains an array of JSON objects, one per row. No metadata. | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | inline_json | Same as the JSON format, except that the &#x60;data&#x60; property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn&#39;t have to re-encode the JSON row data in order to pass it on to its ultimate destination. | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | xlsx | MS Excel spreadsheet | wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document | assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document | wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image || Valid formats vary by destination type and source object. &#x60;wysiwyg_pdf&#x60; is only valid for dashboards, for example.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Scheduled Plan

@return ScheduledPlan

func (*ScheduledPlanApiService) DeleteScheduledPlan 

func (a *ScheduledPlanApiService) DeleteScheduledPlan(ctx _context.Context, scheduledPlanId int64) (string, *_nethttp.Response, error)

DeleteScheduledPlan Delete Scheduled Plan ### Delete a Scheduled Plan Normal users can only delete their own scheduled plans. Admins can delete other users&#39; scheduled plans. This delete cannot be undone.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledPlanId Scheduled Plan Id

@return string

func (*ScheduledPlanApiService) ScheduledPlan 

func (a *ScheduledPlanApiService) ScheduledPlan(ctx _context.Context, scheduledPlanId int64, localVarOptionals *ScheduledPlanOpts) (ScheduledPlan, *_nethttp.Response, error)

ScheduledPlan Get Scheduled Plan ### Get Information About a Scheduled Plan Admins can fetch information about other users&#39; Scheduled Plans.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledPlanId Scheduled Plan Id
  • @param optional nil or *ScheduledPlanOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlanRunOnce 

func (a *ScheduledPlanApiService) ScheduledPlanRunOnce(ctx _context.Context, body ScheduledPlan) (ScheduledPlan, *_nethttp.Response, error)

ScheduledPlanRunOnce Run Scheduled Plan Once ### Run a Scheduled Plan Immediately Create a scheduled plan that runs only once, and immediately. This can be useful for testing a Scheduled Plan before committing to a production schedule. Admins can create scheduled plans on behalf of other users by specifying a user id. This API is rate limited to prevent it from being used for relay spam or DoS attacks #### Email Permissions: For details about permissions required to schedule delivery to email and the safeguards Looker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions). #### Scheduled Plan Destination Formats Scheduled plan destinations must specify the data format to produce and send to the destination. Formats: | format | Description | :-----------: | :--- | | json | A JSON object containing a &#x60;data&#x60; property which contains an array of JSON objects, one per row. No metadata. | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | inline_json | Same as the JSON format, except that the &#x60;data&#x60; property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn&#39;t have to re-encode the JSON row data in order to pass it on to its ultimate destination. | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | xlsx | MS Excel spreadsheet | wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document | assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document | wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image || Valid formats vary by destination type and source object. &#x60;wysiwyg_pdf&#x60; is only valid for dashboards, for example.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Scheduled Plan

@return ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlanRunOnceById 

func (a *ScheduledPlanApiService) ScheduledPlanRunOnceById(ctx _context.Context, scheduledPlanId int64, localVarOptionals *ScheduledPlanRunOnceByIdOpts) (ScheduledPlan, *_nethttp.Response, error)

ScheduledPlanRunOnceById Run Scheduled Plan Once by Id ### Run a Scheduled Plan By Id Immediately This function creates a run-once schedule plan based on an existing scheduled plan, applies modifications (if any) to the new scheduled plan, and runs the new schedule plan immediately. This can be useful for testing modifications to an existing scheduled plan before committing to a production schedule. This function internally performs the following operations: 1. Copies the properties of the existing scheduled plan into a new scheduled plan 2. Copies any properties passed in the JSON body of this request into the new scheduled plan (replacing the original values) 3. Creates the new scheduled plan 4. Runs the new scheduled plan The original scheduled plan is not modified by this operation. Admins can create, modify, and run scheduled plans on behalf of other users by specifying a user id. Non-admins can only create, modify, and run their own scheduled plans. #### Email Permissions: For details about permissions required to schedule delivery to email and the safeguards Looker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions). #### Scheduled Plan Destination Formats Scheduled plan destinations must specify the data format to produce and send to the destination. Formats: | format | Description | :-----------: | :--- | | json | A JSON object containing a &#x60;data&#x60; property which contains an array of JSON objects, one per row. No metadata. | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | inline_json | Same as the JSON format, except that the &#x60;data&#x60; property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn&#39;t have to re-encode the JSON row data in order to pass it on to its ultimate destination. | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | xlsx | MS Excel spreadsheet | wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document | assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document | wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image || Valid formats vary by destination type and source object. &#x60;wysiwyg_pdf&#x60; is only valid for dashboards, for example. This API is rate limited to prevent it from being used for relay spam or DoS attacks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledPlanId Id of schedule plan to copy and run
  • @param optional nil or *ScheduledPlanRunOnceByIdOpts - Optional Parameters:
  • @param "Body" (optional.Interface of WriteScheduledPlan) - Property values to apply to the newly copied scheduled plan before running it

@return ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlansForDashboard 

func (a *ScheduledPlanApiService) ScheduledPlansForDashboard(ctx _context.Context, dashboardId int64, localVarOptionals *ScheduledPlansForDashboardOpts) ([]ScheduledPlan, *_nethttp.Response, error)

ScheduledPlansForDashboard Scheduled Plans for Dashboard ### Get Scheduled Plans for a Dashboard Returns all scheduled plans for a dashboard which belong to the caller or given user. If no user_id is provided, this function returns the scheduled plans owned by the caller. To list all schedules for all users, pass &#x60;all_users&#x3D;true&#x60;. The caller must have &#x60;see_schedules&#x60; permission to see other users&#39; scheduled plans.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dashboardId Dashboard Id
  • @param optional nil or *ScheduledPlansForDashboardOpts - Optional Parameters:
  • @param "UserId" (optional.Int64) - User Id (default is requesting user if not specified)
  • @param "AllUsers" (optional.Bool) - Return scheduled plans belonging to all users for the dashboard
  • @param "Fields" (optional.String) - Requested fields.

@return []ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlansForLook 

func (a *ScheduledPlanApiService) ScheduledPlansForLook(ctx _context.Context, lookId int64, localVarOptionals *ScheduledPlansForLookOpts) ([]ScheduledPlan, *_nethttp.Response, error)

ScheduledPlansForLook Scheduled Plans for Look ### Get Scheduled Plans for a Look Returns all scheduled plans for a look which belong to the caller or given user. If no user_id is provided, this function returns the scheduled plans owned by the caller. To list all schedules for all users, pass &#x60;all_users&#x3D;true&#x60;. The caller must have &#x60;see_schedules&#x60; permission to see other users&#39; scheduled plans.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookId Look Id
  • @param optional nil or *ScheduledPlansForLookOpts - Optional Parameters:
  • @param "UserId" (optional.Int64) - User Id (default is requesting user if not specified)
  • @param "Fields" (optional.String) - Requested fields.
  • @param "AllUsers" (optional.Bool) - Return scheduled plans belonging to all users for the look

@return []ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlansForLookmlDashboard 

func (a *ScheduledPlanApiService) ScheduledPlansForLookmlDashboard(ctx _context.Context, lookmlDashboardId int64, localVarOptionals *ScheduledPlansForLookmlDashboardOpts) ([]ScheduledPlan, *_nethttp.Response, error)

ScheduledPlansForLookmlDashboard Scheduled Plans for LookML Dashboard ### Get Scheduled Plans for a LookML Dashboard Returns all scheduled plans for a LookML Dashboard which belong to the caller or given user. If no user_id is provided, this function returns the scheduled plans owned by the caller. To list all schedules for all users, pass &#x60;all_users&#x3D;true&#x60;. The caller must have &#x60;see_schedules&#x60; permission to see other users&#39; scheduled plans.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookmlDashboardId LookML Dashboard Id
  • @param optional nil or *ScheduledPlansForLookmlDashboardOpts - Optional Parameters:
  • @param "UserId" (optional.Int64) - User Id (default is requesting user if not specified)
  • @param "Fields" (optional.String) - Requested fields.
  • @param "AllUsers" (optional.Bool) - Return scheduled plans belonging to all users for the dashboard

@return []ScheduledPlan

func (*ScheduledPlanApiService) ScheduledPlansForSpace 

func (a *ScheduledPlanApiService) ScheduledPlansForSpace(ctx _context.Context, spaceId int64, localVarOptionals *ScheduledPlansForSpaceOpts) ([]ScheduledPlan, *_nethttp.Response, error)

ScheduledPlansForSpace Scheduled Plans for Space ### Get Scheduled Plans for a Space Returns scheduled plans owned by the caller for a given space id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Space Id
  • @param optional nil or *ScheduledPlansForSpaceOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []ScheduledPlan

func (*ScheduledPlanApiService) UpdateScheduledPlan 

func (a *ScheduledPlanApiService) UpdateScheduledPlan(ctx _context.Context, scheduledPlanId int64, body ScheduledPlan) (ScheduledPlan, *_nethttp.Response, error)

UpdateScheduledPlan Update Scheduled Plan ### Update a Scheduled Plan Admins can update other users&#39; Scheduled Plans. Note: Any scheduled plan destinations specified in an update will **replace** all scheduled plan destinations currently defined for the scheduled plan. For Example: If a scheduled plan has destinations A, B, and C, and you call update on this scheduled plan specifying only B in the destinations, then destinations A and C will be deleted by the update. Updating a scheduled plan to assign null or an empty array to the scheduled_plan_destinations property is an error, as a scheduled plan must always have at least one destination. If you omit the scheduled_plan_destinations property from the object passed to update, then the destinations defined on the original scheduled plan will remain unchanged. #### Email Permissions: For details about permissions required to schedule delivery to email and the safeguards Looker offers to protect against sending to unauthorized email destinations, see [Email Domain Whitelist for Scheduled Looks](https://docs.looker.com/r/api/embed-permissions). #### Scheduled Plan Destination Formats Scheduled plan destinations must specify the data format to produce and send to the destination. Formats: | format | Description | :-----------: | :--- | | json | A JSON object containing a &#x60;data&#x60; property which contains an array of JSON objects, one per row. No metadata. | json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query | inline_json | Same as the JSON format, except that the &#x60;data&#x60; property is a string containing JSON-escaped row data. Additional properties describe the data operation. This format is primarily used to send data to web hooks so that the web hook doesn&#39;t have to re-encode the JSON row data in order to pass it on to its ultimate destination. | csv | Comma separated values with a header | txt | Tab separated values with a header | html | Simple html | xlsx | MS Excel spreadsheet | wysiwyg_pdf | Dashboard rendered in a tiled layout to produce a PDF document | assembled_pdf | Dashboard rendered in a single column layout to produce a PDF document | wysiwyg_png | Dashboard rendered in a tiled layout to produce a PNG image || Valid formats vary by destination type and source object. &#x60;wysiwyg_pdf&#x60; is only valid for dashboards, for example.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param scheduledPlanId Scheduled Plan Id
  • @param body Scheduled Plan

@return ScheduledPlan

type ScheduledPlanDestination 

type ScheduledPlanDestination struct {
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Id of a scheduled plan you own
	ScheduledPlanId int64 `json:"scheduled_plan_id,omitempty"`
	// The data format to send to the given destination. Supported formats vary by destination, but include: \"txt\", \"csv\", \"inline_json\", \"json\", \"json_detail\", \"xlsx\", \"html\", \"wysiwyg_pdf\", \"assembled_pdf\", \"wysiwyg_png\"
	Format string `json:"format,omitempty"`
	// Are values formatted? (containing currency symbols, digit separators, etc.
	ApplyFormatting bool `json:"apply_formatting,omitempty"`
	// Whether visualization options are applied to the results.
	ApplyVis bool `json:"apply_vis,omitempty"`
	// Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'.
	Address string `json:"address,omitempty"`
	// Whether the recipient is a Looker user on the current instance (only applicable for email recipients)
	LookerRecipient bool `json:"looker_recipient,omitempty"`
	// Type of the address ('email', 'webhook', 's3', or 'sftp')
	Type string `json:"type,omitempty"`
	// JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.
	Parameters string `json:"parameters,omitempty"`
	// (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.
	SecretParameters string `json:"secret_parameters,omitempty"`
	// Optional message to be included in scheduled emails
	Message string `json:"message,omitempty"`
}

ScheduledPlanDestination struct for ScheduledPlanDestination

type ScheduledPlanOpts 

type ScheduledPlanOpts struct {
	Fields optional.String
}

ScheduledPlanOpts Optional parameters for the method 'ScheduledPlan'

type ScheduledPlanRunOnceByIdOpts 

type ScheduledPlanRunOnceByIdOpts struct {
	Body optional.Interface
}

ScheduledPlanRunOnceByIdOpts Optional parameters for the method 'ScheduledPlanRunOnceById'

type ScheduledPlansForDashboardOpts 

type ScheduledPlansForDashboardOpts struct {
	UserId   optional.Int64
	AllUsers optional.Bool
	Fields   optional.String
}

ScheduledPlansForDashboardOpts Optional parameters for the method 'ScheduledPlansForDashboard'

type ScheduledPlansForLookOpts 

type ScheduledPlansForLookOpts struct {
	UserId   optional.Int64
	Fields   optional.String
	AllUsers optional.Bool
}

ScheduledPlansForLookOpts Optional parameters for the method 'ScheduledPlansForLook'

type ScheduledPlansForLookmlDashboardOpts 

type ScheduledPlansForLookmlDashboardOpts struct {
	UserId   optional.Int64
	Fields   optional.String
	AllUsers optional.Bool
}

ScheduledPlansForLookmlDashboardOpts Optional parameters for the method 'ScheduledPlansForLookmlDashboard'

type ScheduledPlansForSpaceOpts 

type ScheduledPlansForSpaceOpts struct {
	Fields optional.String
}

ScheduledPlansForSpaceOpts Optional parameters for the method 'ScheduledPlansForSpace'

type SearchContentFavoritesOpts 

type SearchContentFavoritesOpts struct {
	Id                optional.Int64
	UserId            optional.Int64
	ContentMetadataId optional.Int64
	DashboardId       optional.Int64
	LookId            optional.Int64
	Limit             optional.Int64
	Offset            optional.Int64
	Sorts             optional.String
	Fields            optional.String
	FilterOr          optional.Bool
}

SearchContentFavoritesOpts Optional parameters for the method 'SearchContentFavorites'

type SearchContentViewsOpts 

type SearchContentViewsOpts struct {
	ViewCount         optional.Int64
	GroupId           optional.Int64
	LookId            optional.String
	DashboardId       optional.String
	ContentMetadataId optional.Int64
	StartOfWeekDate   optional.String
	AllTime           optional.Bool
	UserId            optional.Int64
	Fields            optional.String
	Limit             optional.Int64
	Offset            optional.Int64
	Sorts             optional.String
	FilterOr          optional.Bool
}

SearchContentViewsOpts Optional parameters for the method 'SearchContentViews'

type SearchDashboardElementsOpts 

type SearchDashboardElementsOpts struct {
	DashboardId optional.Int64
	LookId      optional.Int64
	Title       optional.String
	Deleted     optional.Bool
	Fields      optional.String
	FilterOr    optional.Bool
	Sorts       optional.String
}

SearchDashboardElementsOpts Optional parameters for the method 'SearchDashboardElements'

type SearchDashboardsOpts 

type SearchDashboardsOpts struct {
	Id                optional.Int64
	Slug              optional.String
	Title             optional.String
	Description       optional.String
	ContentFavoriteId optional.Int64
	SpaceId           optional.String
	Deleted           optional.String
	UserId            optional.String
	ViewCount         optional.String
	ContentMetadataId optional.Int64
	Curate            optional.Bool
	Fields            optional.String
	Page              optional.Int64
	PerPage           optional.Int64
	Limit             optional.Int64
	Offset            optional.Int64
	Sorts             optional.String
	FilterOr          optional.Bool
}

SearchDashboardsOpts Optional parameters for the method 'SearchDashboards'

type SearchFoldersOpts 

type SearchFoldersOpts struct {
	Fields    optional.String
	Page      optional.Int64
	PerPage   optional.Int64
	Limit     optional.Int64
	Offset    optional.Int64
	Sorts     optional.String
	Name      optional.String
	Id        optional.Int64
	ParentId  optional.String
	CreatorId optional.String
	FilterOr  optional.Bool
}

SearchFoldersOpts Optional parameters for the method 'SearchFolders'

type SearchGroupsOpts 

type SearchGroupsOpts struct {
	Fields             optional.String
	Limit              optional.Int64
	Offset             optional.Int64
	Sorts              optional.String
	FilterOr           optional.Bool
	Id                 optional.Int64
	Name               optional.String
	ExternalGroupId    optional.Bool
	ExternallyManaged  optional.Bool
	ExternallyOrphaned optional.Bool
}

SearchGroupsOpts Optional parameters for the method 'SearchGroups'

type SearchHomepagesOpts 

type SearchHomepagesOpts struct {
	Title     optional.String
	CreatedAt optional.String
	FirstName optional.String
	LastName  optional.String
	Fields    optional.String
	Favorited optional.Bool
	CreatorId optional.String
	Sorts     optional.String
	Page      optional.Int64
	PerPage   optional.Int64
	Offset    optional.Int64
	Limit     optional.Int64
	FilterOr  optional.Bool
}

SearchHomepagesOpts Optional parameters for the method 'SearchHomepages'

type SearchLooksOpts 

type SearchLooksOpts struct {
	Title             optional.String
	Description       optional.String
	ContentFavoriteId optional.Int64
	SpaceId           optional.String
	UserId            optional.String
	ViewCount         optional.String
	Deleted           optional.Bool
	QueryId           optional.Int64
	Curate            optional.Bool
	Fields            optional.String
	Page              optional.Int64
	PerPage           optional.Int64
	Limit             optional.Int64
	Offset            optional.Int64
	Sorts             optional.String
	FilterOr          optional.Bool
}

SearchLooksOpts Optional parameters for the method 'SearchLooks'

type SearchModelSetsOpts 

type SearchModelSetsOpts struct {
	Fields    optional.String
	Limit     optional.Int64
	Offset    optional.Int64
	Sorts     optional.String
	Id        optional.Int64
	Name      optional.String
	AllAccess optional.Bool
	BuiltIn   optional.Bool
	FilterOr  optional.Bool
}

SearchModelSetsOpts Optional parameters for the method 'SearchModelSets'

type SearchPermissionSetsOpts 

type SearchPermissionSetsOpts struct {
	Fields    optional.String
	Limit     optional.Int64
	Offset    optional.Int64
	Sorts     optional.String
	Id        optional.Int64
	Name      optional.String
	AllAccess optional.Bool
	BuiltIn   optional.Bool
	FilterOr  optional.Bool
}

SearchPermissionSetsOpts Optional parameters for the method 'SearchPermissionSets'

type SearchRolesOpts 

type SearchRolesOpts struct {
	Fields   optional.String
	Limit    optional.Int64
	Offset   optional.Int64
	Sorts    optional.String
	Id       optional.Int64
	Name     optional.String
	BuiltIn  optional.Bool
	FilterOr optional.Bool
}

SearchRolesOpts Optional parameters for the method 'SearchRoles'

type SearchSpacesOpts 

type SearchSpacesOpts struct {
	Fields    optional.String
	Page      optional.Int64
	PerPage   optional.Int64
	Limit     optional.Int64
	Offset    optional.Int64
	Sorts     optional.String
	Name      optional.String
	Id        optional.Int64
	ParentId  optional.String
	CreatorId optional.String
	FilterOr  optional.Bool
}

SearchSpacesOpts Optional parameters for the method 'SearchSpaces'

type SearchThemesOpts 

type SearchThemesOpts struct {
	Id       optional.Int64
	Name     optional.String
	BeginAt  optional.Time
	EndAt    optional.Time
	Limit    optional.Int64
	Offset   optional.Int64
	Sorts    optional.String
	Fields   optional.String
	FilterOr optional.Bool
}

SearchThemesOpts Optional parameters for the method 'SearchThemes'

type SearchUserLoginLockoutsOpts 

type SearchUserLoginLockoutsOpts struct {
	Fields   optional.String
	Page     optional.Int64
	PerPage  optional.Int64
	Sorts    optional.String
	AuthType optional.String
	FullName optional.String
	Email    optional.String
	RemoteId optional.String
	FilterOr optional.Bool
}

SearchUserLoginLockoutsOpts Optional parameters for the method 'SearchUserLoginLockouts'

type SearchUsersNamesOpts 

type SearchUsersNamesOpts struct {
	Fields                 optional.String
	Page                   optional.Int64
	PerPage                optional.Int64
	Sorts                  optional.String
	Id                     optional.Int64
	FirstName              optional.String
	LastName               optional.String
	VerifiedLookerEmployee optional.Bool
	Email                  optional.String
	IsDisabled             optional.Bool
}

SearchUsersNamesOpts Optional parameters for the method 'SearchUsersNames'

type SearchUsersOpts 

type SearchUsersOpts struct {
	Fields                 optional.String
	Page                   optional.Int64
	PerPage                optional.Int64
	Sorts                  optional.String
	Id                     optional.Int64
	FirstName              optional.String
	LastName               optional.String
	VerifiedLookerEmployee optional.Bool
	Email                  optional.String
	IsDisabled             optional.Bool
	FilterOr               optional.Bool
	ContentMetadataId      optional.Int64
	GroupId                optional.Int64
}

SearchUsersOpts Optional parameters for the method 'SearchUsers'

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Session 

type Session struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// IP address of user when this session was initiated
	IpAddress string `json:"ip_address,omitempty"`
	// User's browser type
	Browser string `json:"browser,omitempty"`
	// User's Operating System
	OperatingSystem string `json:"operating_system,omitempty"`
	// City component of user location (derived from IP address)
	City string `json:"city,omitempty"`
	// State component of user location (derived from IP address)
	State string `json:"state,omitempty"`
	// Country component of user location (derived from IP address)
	Country string `json:"country,omitempty"`
	// Type of credentials used for logging in this session
	CredentialsType string `json:"credentials_type,omitempty"`
	// Time when this session was last extended by the user
	ExtendedAt string `json:"extended_at,omitempty"`
	// Number of times this session was extended
	ExtendedCount int64 `json:"extended_count,omitempty"`
	// Actual user in the case when this session represents one user sudo'ing as another
	SudoUserId int64 `json:"sudo_user_id,omitempty"`
	// Time when this session was initiated
	CreatedAt string `json:"created_at,omitempty"`
	// Time when this session will expire
	ExpiresAt string `json:"expires_at,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

Session struct for Session

type SessionApiService 

type SessionApiService service

SessionApiService SessionApi service

func (*SessionApiService) Session 

func (a *SessionApiService) Session(ctx _context.Context) (ApiSession, *_nethttp.Response, error)

Session Get Session ### Get API Session Returns information about the current API session, such as which workspace is selected for the session.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ApiSession

func (*SessionApiService) UpdateSession 

func (a *SessionApiService) UpdateSession(ctx _context.Context, body ApiSession) (ApiSession, *_nethttp.Response, error)

UpdateSession Update Session ### Update API Session #### API Session Workspace You can use this endpoint to change the active workspace for the current API session. Only one workspace can be active in a session. The active workspace can be changed any number of times in a session. The default workspace for API sessions is the \&quot;production\&quot; workspace. All Looker APIs that use projects or lookml models (such as running queries) will use the version of project and model files defined by this workspace for the lifetime of the current API session or until the session workspace is changed again. An API session has the same lifetime as the access_token used to authenticate API requests. Each successful API login generates a new access_token and a new API session. If your Looker API client application needs to work in a dev workspace across multiple API sessions, be sure to select the dev workspace after each login.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Session

@return ApiSession

type SessionConfig 

type SessionConfig struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Allow users to have persistent sessions when they login
	AllowPersistentSessions bool `json:"allow_persistent_sessions,omitempty"`
	// Number of minutes for user sessions.  Must be between 5 and 43200
	SessionMinutes int64 `json:"session_minutes,omitempty"`
	// Allow users to have an unbounded number of concurrent sessions (otherwise, users will be limited to only one session at a time).
	UnlimitedSessionsPerUser bool `json:"unlimited_sessions_per_user,omitempty"`
	// Enforce session logout for sessions that are inactive for 15 minutes.
	UseInactivityBasedLogout bool `json:"use_inactivity_based_logout,omitempty"`
	// Track location of session when user logs in.
	TrackSessionLocation bool `json:"track_session_location,omitempty"`
}

SessionConfig struct for SessionConfig

type SetUserRolesOpts 

type SetUserRolesOpts struct {
	Fields optional.String
}

SetUserRolesOpts Optional parameters for the method 'SetUserRoles'

type Snippet 

type Snippet struct {
	// Name of the snippet
	Name string `json:"name,omitempty"`
	// Label of the snippet
	Label string `json:"label,omitempty"`
	// SQL text of the snippet
	Sql string `json:"sql,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

Snippet struct for Snippet

type Space 

type Space struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Time the space was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// User Id of Creator
	CreatorId int64 `json:"creator_id,omitempty"`
	// Children Count
	ChildCount int64 `json:"child_count,omitempty"`
	// Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login
	ExternalId string `json:"external_id,omitempty"`
	// Space is an embed space
	IsEmbed bool `json:"is_embed,omitempty"`
	// Space is the root embed shared space
	IsEmbedSharedRoot bool `json:"is_embed_shared_root,omitempty"`
	// Space is the root embed users space
	IsEmbedUsersRoot bool `json:"is_embed_users_root,omitempty"`
	// Space is a user's personal space
	IsPersonal bool `json:"is_personal,omitempty"`
	// Space is descendant of a user's personal space
	IsPersonalDescendant bool `json:"is_personal_descendant,omitempty"`
	// Space is the root shared space
	IsSharedRoot bool `json:"is_shared_root,omitempty"`
	// Space is the root user space
	IsUsersRoot bool `json:"is_users_root,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Dashboards
	Dashboards []DashboardBase `json:"dashboards,omitempty"`
	// Looks
	Looks []LookWithDashboards `json:"looks,omitempty"`
}

Space struct for Space

type SpaceAncestorsOpts 

type SpaceAncestorsOpts struct {
	Fields optional.String
}

SpaceAncestorsOpts Optional parameters for the method 'SpaceAncestors'

type SpaceApiService 

type SpaceApiService service

SpaceApiService SpaceApi service

func (*SpaceApiService) AllSpaces 

func (a *SpaceApiService) AllSpaces(ctx _context.Context, localVarOptionals *AllSpacesOpts) ([]SpaceBase, *_nethttp.Response, error)

AllSpaces Get All Spaces ### Get information about all spaces.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllSpacesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []SpaceBase

func (*SpaceApiService) CreateSpace 

func (a *SpaceApiService) CreateSpace(ctx _context.Context, body CreateSpace) (Space, *_nethttp.Response, error)

CreateSpace Create Space ### Create a space with specified information. Caller must have permission to edit the parent space and to create spaces, otherwise the request returns 404 Not Found.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Create a new space

@return Space

func (*SpaceApiService) DeleteSpace 

func (a *SpaceApiService) DeleteSpace(ctx _context.Context, spaceId string) (string, *_nethttp.Response, error)

DeleteSpace Delete Space ### Delete the space with a specific id including any children spaces. **DANGER** this will delete all looks and dashboards in the space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space

@return string

func (*SpaceApiService) SearchSpaces 

func (a *SpaceApiService) SearchSpaces(ctx _context.Context, localVarOptionals *SearchSpacesOpts) ([]Space, *_nethttp.Response, error)

SearchSpaces Search Spaces ### Search Spaces Returns an **array of space objects** that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values. The parameters &#x60;limit&#x60;, and &#x60;offset&#x60; are recommended for fetching results in page-size chunks. Get a **single space** by id with Space(#!/Space/space)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchSpacesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Limit" (optional.Int64) - Number of results to return. (used with offset and takes priority over page and per_page)
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Name" (optional.String) - Match Space title.
  • @param "Id" (optional.Int64) - Match Space id
  • @param "ParentId" (optional.String) - Filter on a children of a particular space.
  • @param "CreatorId" (optional.String) - Filter on spaces created by a particular user.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Space

func (*SpaceApiService) Space 

func (a *SpaceApiService) Space(ctx _context.Context, spaceId string, localVarOptionals *SpaceOpts) (Space, *_nethttp.Response, error)

Space Get Space ### Get information about the space with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Space

func (*SpaceApiService) SpaceAncestors 

func (a *SpaceApiService) SpaceAncestors(ctx _context.Context, spaceId string, localVarOptionals *SpaceAncestorsOpts) ([]Space, *_nethttp.Response, error)

SpaceAncestors Get Space Ancestors ### Get the ancestors of a space

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceAncestorsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Space

func (*SpaceApiService) SpaceChildren 

func (a *SpaceApiService) SpaceChildren(ctx _context.Context, spaceId string, localVarOptionals *SpaceChildrenOpts) ([]Space, *_nethttp.Response, error)

SpaceChildren Get Space Children ### Get the children of a space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceChildrenOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Sorts" (optional.String) - Fields to sort by.

@return []Space

func (*SpaceApiService) SpaceChildrenSearch 

func (a *SpaceApiService) SpaceChildrenSearch(ctx _context.Context, spaceId string, localVarOptionals *SpaceChildrenSearchOpts) ([]Space, *_nethttp.Response, error)

SpaceChildrenSearch Search Space Children ### Search the children of a space

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceChildrenSearchOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Name" (optional.String) - Match Space name.

@return []Space

func (*SpaceApiService) SpaceDashboards 

func (a *SpaceApiService) SpaceDashboards(ctx _context.Context, spaceId string, localVarOptionals *SpaceDashboardsOpts) ([]Dashboard, *_nethttp.Response, error)

SpaceDashboards Get Space Dashboards ### Get the dashboards in a space

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceDashboardsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Dashboard

func (*SpaceApiService) SpaceLooks 

func (a *SpaceApiService) SpaceLooks(ctx _context.Context, spaceId string, localVarOptionals *SpaceLooksOpts) ([]LookWithQuery, *_nethttp.Response, error)

SpaceLooks Get Space Looks ### Get the looks in a space

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceLooksOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []LookWithQuery

func (*SpaceApiService) SpaceParent 

func (a *SpaceApiService) SpaceParent(ctx _context.Context, spaceId string, localVarOptionals *SpaceParentOpts) (Space, *_nethttp.Response, error)

SpaceParent Get Space Parent ### Get the parent of a space

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param optional nil or *SpaceParentOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Space

func (*SpaceApiService) UpdateSpace 

func (a *SpaceApiService) UpdateSpace(ctx _context.Context, spaceId string, body UpdateSpace) (Space, *_nethttp.Response, error)

UpdateSpace Update Space ### Update the space with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param spaceId Id of space
  • @param body Space parameters

@return Space

type SpaceBase 

type SpaceBase struct {
	// Unique Name
	Name string `json:"name"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
	// Unique Id
	Id string `json:"id,omitempty"`
	// Id of content metadata
	ContentMetadataId int64 `json:"content_metadata_id,omitempty"`
	// Time the space was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// User Id of Creator
	CreatorId int64 `json:"creator_id,omitempty"`
	// Children Count
	ChildCount int64 `json:"child_count,omitempty"`
	// Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login
	ExternalId string `json:"external_id,omitempty"`
	// Space is an embed space
	IsEmbed bool `json:"is_embed,omitempty"`
	// Space is the root embed shared space
	IsEmbedSharedRoot bool `json:"is_embed_shared_root,omitempty"`
	// Space is the root embed users space
	IsEmbedUsersRoot bool `json:"is_embed_users_root,omitempty"`
	// Space is a user's personal space
	IsPersonal bool `json:"is_personal,omitempty"`
	// Space is descendant of a user's personal space
	IsPersonalDescendant bool `json:"is_personal_descendant,omitempty"`
	// Space is the root shared space
	IsSharedRoot bool `json:"is_shared_root,omitempty"`
	// Space is the root user space
	IsUsersRoot bool `json:"is_users_root,omitempty"`
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
}

SpaceBase struct for SpaceBase

type SpaceChildrenOpts 

type SpaceChildrenOpts struct {
	Fields  optional.String
	Page    optional.Int64
	PerPage optional.Int64
	Sorts   optional.String
}

SpaceChildrenOpts Optional parameters for the method 'SpaceChildren'

type SpaceChildrenSearchOpts 

type SpaceChildrenSearchOpts struct {
	Fields optional.String
	Sorts  optional.String
	Name   optional.String
}

SpaceChildrenSearchOpts Optional parameters for the method 'SpaceChildrenSearch'

type SpaceDashboardsOpts 

type SpaceDashboardsOpts struct {
	Fields optional.String
}

SpaceDashboardsOpts Optional parameters for the method 'SpaceDashboards'

type SpaceLooksOpts 

type SpaceLooksOpts struct {
	Fields optional.String
}

SpaceLooksOpts Optional parameters for the method 'SpaceLooks'

type SpaceOpts 

type SpaceOpts struct {
	Fields optional.String
}

SpaceOpts Optional parameters for the method 'Space'

type SpaceParentOpts 

type SpaceParentOpts struct {
	Fields optional.String
}

SpaceParentOpts Optional parameters for the method 'SpaceParent'

type SqlQuery 

type SqlQuery struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The identifier of the SQL query
	Slug string `json:"slug,omitempty"`
	// Number of seconds this query took to run the most recent time it was run
	LastRuntime float32 `json:"last_runtime,omitempty"`
	// Number of times this query has been run
	RunCount int64 `json:"run_count,omitempty"`
	// Maximum number of rows this query will display on the SQL Runner page
	BrowserLimit int64 `json:"browser_limit,omitempty"`
	// SQL query text
	Sql string `json:"sql,omitempty"`
	// The most recent time this query was run
	LastRunAt  string           `json:"last_run_at,omitempty"`
	Connection DbConnectionBase `json:"connection,omitempty"`
	// Model name this query uses
	ModelName string     `json:"model_name,omitempty"`
	Creator   UserPublic `json:"creator,omitempty"`
	// Explore page URL for this SQL query
	ExploreUrl string `json:"explore_url,omitempty"`
	// Should this query be rendered as plain text
	Plaintext bool `json:"plaintext,omitempty"`
	// Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A \"type\" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
	VisConfig map[string]string `json:"vis_config,omitempty"`
}

SqlQuery struct for SqlQuery

type SqlQueryCreate 

type SqlQueryCreate struct {
	// Name of the db connection on which to run this query
	ConnectionName string `json:"connection_name,omitempty"`
	// (DEPRECATED) Use `connection_name` instead
	ConnectionId string `json:"connection_id,omitempty"`
	// Name of LookML Model (this or `connection_id` required)
	ModelName string `json:"model_name,omitempty"`
	// SQL query
	Sql string `json:"sql,omitempty"`
	// Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A \"type\" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
	VisConfig map[string]string `json:"vis_config,omitempty"`
}

SqlQueryCreate struct for SqlQueryCreate

type SyncLookmlDashboardOpts 

type SyncLookmlDashboardOpts struct {
	RawLocale optional.Bool
}

SyncLookmlDashboardOpts Optional parameters for the method 'SyncLookmlDashboard'

type TestConnectionConfigOpts 

type TestConnectionConfigOpts struct {
	Tests optional.Interface
}

TestConnectionConfigOpts Optional parameters for the method 'TestConnectionConfig'

type TestConnectionOpts 

type TestConnectionOpts struct {
	Tests optional.Interface
}

TestConnectionOpts Optional parameters for the method 'TestConnection'

type Theme 

type Theme struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Timestamp for when this theme becomes active. Null=always
	BeginAt time.Time `json:"begin_at,omitempty"`
	// Timestamp for when this theme expires. Null=never
	EndAt time.Time `json:"end_at,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Name of theme. Can only be alphanumeric and underscores.
	Name     string        `json:"name,omitempty"`
	Settings ThemeSettings `json:"settings,omitempty"`
}

Theme struct for Theme

type ThemeApiService 

type ThemeApiService service

ThemeApiService ThemeApi service

func (*ThemeApiService) ActiveThemes 

func (a *ThemeApiService) ActiveThemes(ctx _context.Context, localVarOptionals *ActiveThemesOpts) ([]Theme, *_nethttp.Response, error)

ActiveThemes Get Active Themes ### Get active themes Returns an array of active themes. If the &#x60;name&#x60; parameter is specified, it will return an array with one theme if it&#39;s active and found. The optional &#x60;ts&#x60; parameter can specify a different timestamp than \&quot;now.\&quot; **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ActiveThemesOpts - Optional Parameters:
  • @param "Name" (optional.String) - Name of theme
  • @param "Ts" (optional.Time) - Timestamp representing the target datetime for the active period. Defaults to 'now'
  • @param "Fields" (optional.String) - Requested fields.

@return []Theme

func (*ThemeApiService) AllThemes 

func (a *ThemeApiService) AllThemes(ctx _context.Context, localVarOptionals *AllThemesOpts) ([]Theme, *_nethttp.Response, error)

AllThemes Get All Themes ### Get an array of all existing themes Get a **single theme** by id with Theme(#!/Theme/theme) This method returns an array of all existing themes. The active time for the theme is not considered. **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllThemesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Theme

func (*ThemeApiService) CreateTheme 

func (a *ThemeApiService) CreateTheme(ctx _context.Context, body Theme) (Theme, *_nethttp.Response, error)

CreateTheme Create Theme ### Create a theme Creates a new theme object, returning the theme details, including the created id. If &#x60;settings&#x60; are not specified, the default theme settings will be copied into the new theme. The theme &#x60;name&#x60; can only contain alphanumeric characters or underscores. Theme names should not contain any confidential information, such as customer names. **Update** an existing theme with [Update Theme](#!/Theme/update_theme) **Permanently delete** an existing theme with [Delete Theme](#!/Theme/delete_theme) For more information, see [Creating and Applying Themes](https://looker.com/docs/r/admin/themes). **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Theme

@return Theme

func (*ThemeApiService) DefaultTheme 

func (a *ThemeApiService) DefaultTheme(ctx _context.Context, localVarOptionals *DefaultThemeOpts) (Theme, *_nethttp.Response, error)

DefaultTheme Get Default Theme ### Get the default theme Returns the active theme object set as the default. The **default** theme name can be set in the UI on the Admin|Theme UI page The optional &#x60;ts&#x60; parameter can specify a different timestamp than \&quot;now.\&quot; If specified, it returns the default theme at the time indicated.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DefaultThemeOpts - Optional Parameters:
  • @param "Ts" (optional.Time) - Timestamp representing the target datetime for the active period. Defaults to 'now'

@return Theme

func (*ThemeApiService) DeleteTheme 

func (a *ThemeApiService) DeleteTheme(ctx _context.Context, themeId string) (string, *_nethttp.Response, error)

DeleteTheme Delete Theme ### Delete a specific theme by id This operation permanently deletes the identified theme from the database. Because multiple themes can have the same name (with different activation time spans) themes can only be deleted by ID. All IDs associated with a theme name can be retrieved by searching for the theme name with [Theme Search](#!/Theme/search). **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param themeId Id of theme

@return string

func (*ThemeApiService) SearchThemes 

func (a *ThemeApiService) SearchThemes(ctx _context.Context, localVarOptionals *SearchThemesOpts) ([]Theme, *_nethttp.Response, error)

SearchThemes Search Themes ### Search all themes for matching criteria. Returns an **array of theme objects** that match the specified search criteria. | Search Parameters | Description | :-------------------: | :------ | | &#x60;begin_at&#x60; only | Find themes active at or after &#x60;begin_at&#x60; | &#x60;end_at&#x60; only | Find themes active at or before &#x60;end_at&#x60; | both set | Find themes with an active inclusive period between &#x60;begin_at&#x60; and &#x60;end_at&#x60; Note: Range matching requires boolean AND logic. When using &#x60;begin_at&#x60; and &#x60;end_at&#x60; together, do not use &#x60;filter_or&#x60;&#x3D;TRUE If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values. Get a **single theme** by id with Theme(#!/Theme/theme) **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchThemesOpts - Optional Parameters:
  • @param "Id" (optional.Int64) - Match theme id.
  • @param "Name" (optional.String) - Match theme name.
  • @param "BeginAt" (optional.Time) - Timestamp for activation.
  • @param "EndAt" (optional.Time) - Timestamp for expiration.
  • @param "Limit" (optional.Int64) - Number of results to return (used with `offset`).
  • @param "Offset" (optional.Int64) - Number of results to skip before returning any (used with `limit`).
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Fields" (optional.String) - Requested fields.
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []Theme

func (*ThemeApiService) SetDefaultTheme 

func (a *ThemeApiService) SetDefaultTheme(ctx _context.Context, name string) (Theme, *_nethttp.Response, error)

SetDefaultTheme Set Default Theme ### Set the global default theme by theme name Only Admin users can call this function. Only an active theme with no expiration (&#x60;end_at&#x60; not set) can be assigned as the default theme. As long as a theme has an active record with no expiration, it can be set as the default. [Create Theme](#!/Theme/create) has detailed information on rules for default and active themes Returns the new specified default theme object. **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Name of theme to set as default

@return Theme

func (*ThemeApiService) Theme 

func (a *ThemeApiService) Theme(ctx _context.Context, themeId string, localVarOptionals *ThemeOpts) (Theme, *_nethttp.Response, error)

Theme Get Theme ### Get a theme by ID Use this to retrieve a specific theme, whether or not it&#39;s currently active. **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param themeId Id of theme
  • @param optional nil or *ThemeOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Theme

func (*ThemeApiService) ThemeOrDefault 

func (a *ThemeApiService) ThemeOrDefault(ctx _context.Context, name string, localVarOptionals *ThemeOrDefaultOpts) (Theme, *_nethttp.Response, error)

ThemeOrDefault Get Theme or Default ### Get the named theme if it&#39;s active. Otherwise, return the default theme The optional &#x60;ts&#x60; parameter can specify a different timestamp than \&quot;now.\&quot; Note: API users with &#x60;show&#x60; ability can call this function **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Name of theme
  • @param optional nil or *ThemeOrDefaultOpts - Optional Parameters:
  • @param "Ts" (optional.Time) - Timestamp representing the target datetime for the active period. Defaults to 'now'

@return Theme

func (*ThemeApiService) UpdateTheme 

func (a *ThemeApiService) UpdateTheme(ctx _context.Context, themeId string, body Theme) (Theme, *_nethttp.Response, error)

UpdateTheme Update Theme ### Update the theme by id. **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param themeId Id of theme
  • @param body Theme

@return Theme

func (*ThemeApiService) ValidateTheme 

func (a *ThemeApiService) ValidateTheme(ctx _context.Context, body Theme) (ValidationError, *_nethttp.Response, error)

ValidateTheme Validate Theme ### Validate a theme with the specified information Validates all values set for the theme, returning any errors encountered, or 200 OK if valid See [Create Theme](#!/Theme/create_theme) for constraints **Note**: Custom themes needs to be enabled by Looker. Unless custom themes are enabled, only the automatically generated default theme can be used. Please contact your Account Manager or support@looker.com to update your license for this feature.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Theme

@return ValidationError

type ThemeOpts 

type ThemeOpts struct {
	Fields optional.String
}

ThemeOpts Optional parameters for the method 'Theme'

type ThemeOrDefaultOpts 

type ThemeOrDefaultOpts struct {
	Ts optional.Time
}

ThemeOrDefaultOpts Optional parameters for the method 'ThemeOrDefault'

type ThemeSettings 

type ThemeSettings struct {
	// Default background color
	BackgroundColor string `json:"background_color,omitempty"`
	// Base font size for scaling fonts
	BaseFontSize string `json:"base_font_size,omitempty"`
	// Optional. ID of color collection to use with the theme. Use an empty string for none.
	ColorCollectionId string `json:"color_collection_id,omitempty"`
	// Default font color
	FontColor string `json:"font_color,omitempty"`
	// Primary font family
	FontFamily string `json:"font_family,omitempty"`
	// Source specification for font
	FontSource string `json:"font_source,omitempty"`
	// Info button color
	InfoButtonColor string `json:"info_button_color,omitempty"`
	// Primary button color
	PrimaryButtonColor string `json:"primary_button_color,omitempty"`
	// Toggle to show filters. Defaults to true.
	ShowFiltersBar bool `json:"show_filters_bar,omitempty"`
	// Toggle to show the title. Defaults to true.
	ShowTitle bool `json:"show_title,omitempty"`
	// Text color for text tiles
	TextTileTextColor string `json:"text_tile_text_color,omitempty"`
	// Background color for tiles
	TileBackgroundColor string `json:"tile_background_color,omitempty"`
	// Text color for tiles
	TileTextColor string `json:"tile_text_color,omitempty"`
	// Color for titles
	TitleColor string `json:"title_color,omitempty"`
	// Warning button color
	WarnButtonColor string `json:"warn_button_color,omitempty"`
}

ThemeSettings struct for ThemeSettings

type Timezone 

type Timezone struct {
	// Timezone
	Value string `json:"value,omitempty"`
	// Description of timezone
	Label string `json:"label,omitempty"`
	// Timezone group (e.g Common, Other, etc.)
	Group string `json:"group,omitempty"`
}

Timezone struct for Timezone

type UpdateCustomWelcomeEmailOpts 

type UpdateCustomWelcomeEmailOpts struct {
	SendTestWelcomeEmail optional.Bool
}

UpdateCustomWelcomeEmailOpts Optional parameters for the method 'UpdateCustomWelcomeEmail'

type UpdateDashboardElementOpts 

type UpdateDashboardElementOpts struct {
	Fields optional.String
}

UpdateDashboardElementOpts Optional parameters for the method 'UpdateDashboardElement'

type UpdateDashboardFilterOpts 

type UpdateDashboardFilterOpts struct {
	Fields optional.String
}

UpdateDashboardFilterOpts Optional parameters for the method 'UpdateDashboardFilter'

type UpdateDashboardLayoutComponentOpts 

type UpdateDashboardLayoutComponentOpts struct {
	Fields optional.String
}

UpdateDashboardLayoutComponentOpts Optional parameters for the method 'UpdateDashboardLayoutComponent'

type UpdateDashboardLayoutOpts 

type UpdateDashboardLayoutOpts struct {
	Fields optional.String
}

UpdateDashboardLayoutOpts Optional parameters for the method 'UpdateDashboardLayout'

type UpdateFolder 

type UpdateFolder struct {
	// Unique Name
	Name string `json:"name,omitempty"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
}

UpdateFolder struct for UpdateFolder

type UpdateGroupOpts 

type UpdateGroupOpts struct {
	Fields optional.String
}

UpdateGroupOpts Optional parameters for the method 'UpdateGroup'

type UpdateHomepageItemOpts 

type UpdateHomepageItemOpts struct {
	Fields optional.String
}

UpdateHomepageItemOpts Optional parameters for the method 'UpdateHomepageItem'

type UpdateHomepageOpts 

type UpdateHomepageOpts struct {
	Fields optional.String
}

UpdateHomepageOpts Optional parameters for the method 'UpdateHomepage'

type UpdateHomepageSectionOpts 

type UpdateHomepageSectionOpts struct {
	Fields optional.String
}

UpdateHomepageSectionOpts Optional parameters for the method 'UpdateHomepageSection'

type UpdateIntegrationHubOpts 

type UpdateIntegrationHubOpts struct {
	Fields optional.String
}

UpdateIntegrationHubOpts Optional parameters for the method 'UpdateIntegrationHub'

type UpdateIntegrationOpts 

type UpdateIntegrationOpts struct {
	Fields optional.String
}

UpdateIntegrationOpts Optional parameters for the method 'UpdateIntegration'

type UpdateLookOpts 

type UpdateLookOpts struct {
	Fields optional.String
}

UpdateLookOpts Optional parameters for the method 'UpdateLook'

type UpdateProjectOpts 

type UpdateProjectOpts struct {
	Fields optional.String
}

UpdateProjectOpts Optional parameters for the method 'UpdateProject'

type UpdateSpace 

type UpdateSpace struct {
	// Unique Name
	Name string `json:"name,omitempty"`
	// Id of Parent. If the parent id is null, this is a root-level entry
	ParentId string `json:"parent_id,omitempty"`
}

UpdateSpace struct for UpdateSpace

type UpdateUserAttributeOpts 

type UpdateUserAttributeOpts struct {
	Fields optional.String
}

UpdateUserAttributeOpts Optional parameters for the method 'UpdateUserAttribute'

type UpdateUserCredentialsEmailOpts 

type UpdateUserCredentialsEmailOpts struct {
	Fields optional.String
}

UpdateUserCredentialsEmailOpts Optional parameters for the method 'UpdateUserCredentialsEmail'

type UpdateUserOpts 

type UpdateUserOpts struct {
	Fields optional.String
}

UpdateUserOpts Optional parameters for the method 'UpdateUser'

type User 

type User struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// URL for the avatar image (may be generic)
	AvatarUrl string `json:"avatar_url,omitempty"`
	// URL for the avatar image (may be generic), does not specify size
	AvatarUrlWithoutSizing string `json:"avatar_url_without_sizing,omitempty"`
	// API 3 credentials
	CredentialsApi3  []CredentialsApi3 `json:"credentials_api3,omitempty"`
	CredentialsEmail CredentialsEmail  `json:"credentials_email,omitempty"`
	// Embed credentials
	CredentialsEmbed        []CredentialsEmbed      `json:"credentials_embed,omitempty"`
	CredentialsGoogle       CredentialsGoogle       `json:"credentials_google,omitempty"`
	CredentialsLdap         CredentialsLdap         `json:"credentials_ldap,omitempty"`
	CredentialsLookerOpenid CredentialsLookerOpenid `json:"credentials_looker_openid,omitempty"`
	CredentialsOidc         CredentialsOidc         `json:"credentials_oidc,omitempty"`
	CredentialsSaml         CredentialsSaml         `json:"credentials_saml,omitempty"`
	CredentialsTotp         CredentialsTotp         `json:"credentials_totp,omitempty"`
	// Full name for display (available only if both first_name and last_name are set)
	DisplayName string `json:"display_name,omitempty"`
	// EMail address
	Email string `json:"email,omitempty"`
	// (Embed only) ID of user's group space based on the external_group_id optionally specified during embed user login
	EmbedGroupSpaceId int64 `json:"embed_group_space_id,omitempty"`
	// First name
	FirstName string `json:"first_name,omitempty"`
	// Array of ids of the groups for this user
	GroupIds []int64 `json:"group_ids,omitempty"`
	// ID string for user's home space
	HomeSpaceId string `json:"home_space_id,omitempty"`
	// ID string for user's home folder
	HomeFolderId string `json:"home_folder_id,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Account has been disabled
	IsDisabled bool `json:"is_disabled,omitempty"`
	// Last name
	LastName string `json:"last_name,omitempty"`
	// User's preferred locale. User locale takes precedence over Looker's system-wide default locale. Locale determines language of display strings and date and numeric formatting in API responses. Locale string must be a 2 letter language code or a combination of language code and region code: 'en' or 'en-US', for example.
	Locale string `json:"locale,omitempty"`
	// Array of strings representing the Looker versions that this user has used (this only goes back as far as '3.54.0')
	LookerVersions []string `json:"looker_versions,omitempty"`
	// User's dev workspace has been checked for presence of applicable production projects
	ModelsDirValidated bool `json:"models_dir_validated,omitempty"`
	// ID of user's personal space
	PersonalSpaceId int64 `json:"personal_space_id,omitempty"`
	// ID of user's personal folder
	PersonalFolderId int64 `json:"personal_folder_id,omitempty"`
	// User is identified as an employee of Looker
	PresumedLookerEmployee bool `json:"presumed_looker_employee,omitempty"`
	// Array of ids of the roles for this user
	RoleIds []int64 `json:"role_ids,omitempty"`
	// Active sessions
	Sessions []Session `json:"sessions,omitempty"`
	// Per user dictionary of undocumented state information owned by the Looker UI.
	UiState map[string]string `json:"ui_state,omitempty"`
	// User is identified as an employee of Looker who has been verified via Looker corporate authentication
	VerifiedLookerEmployee bool `json:"verified_looker_employee,omitempty"`
	// User's roles are managed by an external directory like SAML or LDAP and can not be changed directly.
	RolesExternallyManaged bool `json:"roles_externally_managed,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

User struct for User

type UserApiService 

type UserApiService service

UserApiService UserApi service

func (*UserApiService) AllUserCredentialsApi3s 

func (a *UserApiService) AllUserCredentialsApi3s(ctx _context.Context, userId int64, localVarOptionals *AllUserCredentialsApi3sOpts) ([]CredentialsApi3, *_nethttp.Response, error)

AllUserCredentialsApi3s Get All API 3 Credentials ### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *AllUserCredentialsApi3sOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []CredentialsApi3

func (*UserApiService) AllUserCredentialsEmbeds 

func (a *UserApiService) AllUserCredentialsEmbeds(ctx _context.Context, userId int64, localVarOptionals *AllUserCredentialsEmbedsOpts) ([]CredentialsEmbed, *_nethttp.Response, error)

AllUserCredentialsEmbeds Get All Embedding Credentials ### Embed login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *AllUserCredentialsEmbedsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []CredentialsEmbed

func (*UserApiService) AllUserSessions 

func (a *UserApiService) AllUserSessions(ctx _context.Context, userId int64, localVarOptionals *AllUserSessionsOpts) ([]Session, *_nethttp.Response, error)

AllUserSessions Get All Web Login Sessions ### Web login session for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *AllUserSessionsOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Session

func (*UserApiService) AllUsers 

func (a *UserApiService) AllUsers(ctx _context.Context, localVarOptionals *AllUsersOpts) ([]User, *_nethttp.Response, error)

AllUsers Get All Users ### Get information about all users.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllUsersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Page" (optional.Int64) - Requested page.
  • @param "PerPage" (optional.Int64) - Results per page.
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Ids" (optional.Interface of []int64) - Optional list of ids to get specific users.

@return []User

func (*UserApiService) CreateUser 

func (a *UserApiService) CreateUser(ctx _context.Context, localVarOptionals *CreateUserOpts) (User, *_nethttp.Response, error)

CreateUser Create User ### Create a user with the specified information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateUserOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Body" (optional.Interface of User) - User

@return User

func (*UserApiService) CreateUserCredentialsApi3 

func (a *UserApiService) CreateUserCredentialsApi3(ctx _context.Context, userId int64, localVarOptionals *CreateUserCredentialsApi3Opts) (CredentialsApi3, *_nethttp.Response, error)

CreateUserCredentialsApi3 Create API 3 Credential ### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *CreateUserCredentialsApi3Opts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Body" (optional.Interface of CredentialsApi3) - API 3 Credential

@return CredentialsApi3

func (*UserApiService) CreateUserCredentialsEmail 

func (a *UserApiService) CreateUserCredentialsEmail(ctx _context.Context, userId int64, body CredentialsEmail, localVarOptionals *CreateUserCredentialsEmailOpts) (CredentialsEmail, *_nethttp.Response, error)

CreateUserCredentialsEmail Create Email/Password Credential ### Email/password login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param body Email/Password Credential
  • @param optional nil or *CreateUserCredentialsEmailOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsEmail

func (*UserApiService) CreateUserCredentialsEmailPasswordReset 

func (a *UserApiService) CreateUserCredentialsEmailPasswordReset(ctx _context.Context, userId int64, localVarOptionals *CreateUserCredentialsEmailPasswordResetOpts) (CredentialsEmail, *_nethttp.Response, error)

CreateUserCredentialsEmailPasswordReset Create Password Reset Token ### Create a password reset token. This will create a cryptographically secure random password reset token for the user. If the user already has a password reset token then this invalidates the old token and creates a new one. The token is expressed as the &#39;password_reset_url&#39; of the user&#39;s email/password credential object. This takes an optional &#39;expires&#39; param to indicate if the new token should be an expiring token. Tokens that expire are typically used for self-service password resets for existing users. Invitation emails for new users typically are not set to expire. The expire period is always 60 minutes when expires is enabled. This method can be called with an empty body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param optional nil or *CreateUserCredentialsEmailPasswordResetOpts - Optional Parameters:
  • @param "Expires" (optional.Bool) - Expiring token.
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsEmail

func (*UserApiService) CreateUserCredentialsTotp 

func (a *UserApiService) CreateUserCredentialsTotp(ctx _context.Context, userId int64, localVarOptionals *CreateUserCredentialsTotpOpts) (CredentialsTotp, *_nethttp.Response, error)

CreateUserCredentialsTotp Create Two-Factor Credential ### Two-factor login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *CreateUserCredentialsTotpOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Body" (optional.Interface of CredentialsTotp) - Two-Factor Credential

@return CredentialsTotp

func (*UserApiService) DeleteUser 

func (a *UserApiService) DeleteUser(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUser Delete User ### Delete the user with a specific id. **DANGER** this will delete the user and all looks and other information owned by the user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user

@return string

func (*UserApiService) DeleteUserAttributeUserValue 

func (a *UserApiService) DeleteUserAttributeUserValue(ctx _context.Context, userId int64, userAttributeId int64) (*_nethttp.Response, error)

DeleteUserAttributeUserValue Delete User Attribute User Value ### Delete a user attribute value from a user&#39;s account settings. After the user attribute value is deleted from the user&#39;s account settings, subsequent requests for the user attribute value for this user will draw from the user&#39;s groups or the default value of the user attribute. See [Get User Attribute Values](#!/User/user_attribute_user_values) for more information about how user attribute values are resolved.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param userAttributeId Id of user attribute

func (*UserApiService) DeleteUserCredentialsApi3 

func (a *UserApiService) DeleteUserCredentialsApi3(ctx _context.Context, userId int64, credentialsApi3Id int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsApi3 Delete API 3 Credential ### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param credentialsApi3Id id of API 3 Credential

@return string

func (*UserApiService) DeleteUserCredentialsEmail 

func (a *UserApiService) DeleteUserCredentialsEmail(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsEmail Delete Email/Password Credential ### Email/password login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsEmbed 

func (a *UserApiService) DeleteUserCredentialsEmbed(ctx _context.Context, userId int64, credentialsEmbedId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsEmbed Delete Embedding Credential ### Embed login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param credentialsEmbedId id of Embedding Credential

@return string

func (*UserApiService) DeleteUserCredentialsGoogle 

func (a *UserApiService) DeleteUserCredentialsGoogle(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsGoogle Delete Google Auth Credential ### Google authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsLdap 

func (a *UserApiService) DeleteUserCredentialsLdap(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsLdap Delete LDAP Credential ### LDAP login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsLookerOpenid 

func (a *UserApiService) DeleteUserCredentialsLookerOpenid(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsLookerOpenid Delete Looker OpenId Credential ### Looker Openid login information for the specified user. Used by Looker Analysts.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsOidc 

func (a *UserApiService) DeleteUserCredentialsOidc(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsOidc Delete OIDC Auth Credential ### OpenID Connect (OIDC) authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsSaml 

func (a *UserApiService) DeleteUserCredentialsSaml(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsSaml Delete Saml Auth Credential ### Saml authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserCredentialsTotp 

func (a *UserApiService) DeleteUserCredentialsTotp(ctx _context.Context, userId int64) (string, *_nethttp.Response, error)

DeleteUserCredentialsTotp Delete Two-Factor Credential ### Two-factor login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user

@return string

func (*UserApiService) DeleteUserSession 

func (a *UserApiService) DeleteUserSession(ctx _context.Context, userId int64, sessionId int64) (string, *_nethttp.Response, error)

DeleteUserSession Delete Web Login Session ### Web login session for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param sessionId id of Web Login Session

@return string

func (*UserApiService) Me 

func (a *UserApiService) Me(ctx _context.Context, localVarOptionals *MeOpts) (User, *_nethttp.Response, error)

Me Get Current User ### Get information about the current user; i.e. the user account currently calling the API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *MeOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return User

func (*UserApiService) SearchUsers 

func (a *UserApiService) SearchUsers(ctx _context.Context, localVarOptionals *SearchUsersOpts) ([]User, *_nethttp.Response, error)

SearchUsers Search Users ### Search users Returns all&lt;sup&gt;*&lt;/sup&gt; user records that match the given search criteria. If multiple search params are given and &#x60;filter_or&#x60; is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match *all* search param criteria will be returned. If &#x60;filter_or&#x60; is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match **any** of the search criteria. String search params use case-insensitive matching. String search params can contain &#x60;%&#x60; and &#39;_&#39; as SQL LIKE pattern match wildcard expressions. example&#x3D;\&quot;dan%\&quot; will match \&quot;danger\&quot; and \&quot;Danzig\&quot; but not \&quot;David\&quot; example&#x3D;\&quot;D_m%\&quot; will match \&quot;Damage\&quot; and \&quot;dump\&quot; Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept \&quot;IS NULL\&quot; and \&quot;NOT NULL\&quot; as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only \&quot;true\&quot; and \&quot;false\&quot; as values. (&lt;sup&gt;*&lt;/sup&gt;) Results are always filtered to the level of information the caller is permitted to view. Looker admins can see all user details; normal users in an open system can see names of other users but no details; normal users in a closed system can only see names of other users who are members of the same group as the user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchUsersOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Include only these fields in the response
  • @param "Page" (optional.Int64) - Return only page N of paginated results
  • @param "PerPage" (optional.Int64) - Return N rows of data per page
  • @param "Sorts" (optional.String) - Fields to sort by.
  • @param "Id" (optional.Int64) - Match User Id.
  • @param "FirstName" (optional.String) - Match First name.
  • @param "LastName" (optional.String) - Match Last name.
  • @param "VerifiedLookerEmployee" (optional.Bool) - Search for user accounts associated with Looker employees
  • @param "Email" (optional.String) - Search for the user with this email address
  • @param "IsDisabled" (optional.Bool) - Search for disabled user accounts
  • @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression
  • @param "ContentMetadataId" (optional.Int64) - Search for users who have access to this content_metadata item
  • @param "GroupId" (optional.Int64) - Search for users who are direct members of this group

@return []User

func (*UserApiService) SearchUsersNames 

func (a *UserApiService) SearchUsersNames(ctx _context.Context, pattern string, localVarOptionals *SearchUsersNamesOpts) ([]User, *_nethttp.Response, error)

SearchUsersNames Search User Names ### Search for user accounts by name Returns all user accounts where &#x60;first_name&#x60; OR &#x60;last_name&#x60; OR &#x60;email&#x60; field values match a pattern. The pattern can contain &#x60;%&#x60; and &#x60;_&#x60; wildcards as in SQL LIKE expressions. Any additional search params will be combined into a logical AND expression.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param pattern Pattern to match
  • @param optional nil or *SearchUsersNamesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Include only these fields in the response
  • @param "Page" (optional.Int64) - Return only page N of paginated results
  • @param "PerPage" (optional.Int64) - Return N rows of data per page
  • @param "Sorts" (optional.String) - Fields to sort by
  • @param "Id" (optional.Int64) - Match User Id
  • @param "FirstName" (optional.String) - Match First name
  • @param "LastName" (optional.String) - Match Last name
  • @param "VerifiedLookerEmployee" (optional.Bool) - Match Verified Looker employee
  • @param "Email" (optional.String) - Match Email Address
  • @param "IsDisabled" (optional.Bool) - Include or exclude disabled accounts in the results

@return []User

func (*UserApiService) SetUserAttributeUserValue 

func (a *UserApiService) SetUserAttributeUserValue(ctx _context.Context, userId int64, userAttributeId int64, body UserAttributeWithValue) (UserAttributeWithValue, *_nethttp.Response, error)

SetUserAttributeUserValue Set User Attribute User Value ### Store a custom value for a user attribute in a user&#39;s account settings. Per-user user attribute values take precedence over group or default values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param userAttributeId Id of user attribute
  • @param body New attribute value for user.

@return UserAttributeWithValue

func (*UserApiService) SetUserRoles 

func (a *UserApiService) SetUserRoles(ctx _context.Context, userId int64, body []int64, localVarOptionals *SetUserRolesOpts) ([]Role, *_nethttp.Response, error)

SetUserRoles Set User Roles ### Set roles of the user with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param body array of roles ids for user
  • @param optional nil or *SetUserRolesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []Role

func (*UserApiService) UpdateUser 

func (a *UserApiService) UpdateUser(ctx _context.Context, userId int64, body User, localVarOptionals *UpdateUserOpts) (User, *_nethttp.Response, error)

UpdateUser Update User ### Update information about the user with a specific id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param body User
  • @param optional nil or *UpdateUserOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return User

func (*UserApiService) UpdateUserCredentialsEmail 

func (a *UserApiService) UpdateUserCredentialsEmail(ctx _context.Context, userId int64, body CredentialsEmail, localVarOptionals *UpdateUserCredentialsEmailOpts) (CredentialsEmail, *_nethttp.Response, error)

UpdateUserCredentialsEmail Update Email/Password Credential ### Email/password login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param body Email/Password Credential
  • @param optional nil or *UpdateUserCredentialsEmailOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsEmail

func (*UserApiService) User 

func (a *UserApiService) User(ctx _context.Context, userId int64, localVarOptionals *UserOpts) (User, *_nethttp.Response, error)

User Get User by Id ### Get information about the user with a specific id. If the caller is an admin or the caller is the user being specified, then full user information will be returned. Otherwise, a minimal &#39;public&#39; variant of the user information will be returned. This contains The user name and avatar url, but no sensitive information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param optional nil or *UserOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return User

func (*UserApiService) UserAttributeUserValues 

func (a *UserApiService) UserAttributeUserValues(ctx _context.Context, userId int64, localVarOptionals *UserAttributeUserValuesOpts) ([]UserAttributeWithValue, *_nethttp.Response, error)

UserAttributeUserValues Get User Attribute Values ### Get user attribute values for a given user. Returns the values of specified user attributes (or all user attributes) for a certain user. A value for each user attribute is searched for in the following locations, in this order: 1. in the user&#39;s account information 1. in groups that the user is a member of 1. the default value of the user attribute If more than one group has a value defined for a user attribute, the group with the lowest rank wins. The response will only include user attributes for which values were found. Use &#x60;include_unset&#x3D;true&#x60; to include empty records for user attributes with no value. The value of all hidden user attributes will be blank.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param optional nil or *UserAttributeUserValuesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "UserAttributeIds" (optional.Interface of []int64) - Specific user attributes to request. Omit or leave blank to request all user attributes.
  • @param "AllValues" (optional.Bool) - If true, returns all values in the search path instead of just the first value found. Useful for debugging group precedence.
  • @param "IncludeUnset" (optional.Bool) - If true, returns an empty record for each requested attribute that has no user, group, or default value.

@return []UserAttributeWithValue

func (*UserApiService) UserCredentialsApi3 

func (a *UserApiService) UserCredentialsApi3(ctx _context.Context, userId int64, credentialsApi3Id int64, localVarOptionals *UserCredentialsApi3Opts) (CredentialsApi3, *_nethttp.Response, error)

UserCredentialsApi3 Get API 3 Credential ### API 3 login information for the specified user. This is for the newer API keys that can be added for any user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param credentialsApi3Id Id of API 3 Credential
  • @param optional nil or *UserCredentialsApi3Opts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsApi3

func (*UserApiService) UserCredentialsEmail 

func (a *UserApiService) UserCredentialsEmail(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsEmailOpts) (CredentialsEmail, *_nethttp.Response, error)

UserCredentialsEmail Get Email/Password Credential ### Email/password login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsEmailOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsEmail

func (*UserApiService) UserCredentialsEmbed 

func (a *UserApiService) UserCredentialsEmbed(ctx _context.Context, userId int64, credentialsEmbedId int64, localVarOptionals *UserCredentialsEmbedOpts) (CredentialsEmbed, *_nethttp.Response, error)

UserCredentialsEmbed Get Embedding Credential ### Embed login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param credentialsEmbedId Id of Embedding Credential
  • @param optional nil or *UserCredentialsEmbedOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsEmbed

func (*UserApiService) UserCredentialsGoogle 

func (a *UserApiService) UserCredentialsGoogle(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsGoogleOpts) (CredentialsGoogle, *_nethttp.Response, error)

UserCredentialsGoogle Get Google Auth Credential ### Google authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsGoogleOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsGoogle

func (*UserApiService) UserCredentialsLdap 

func (a *UserApiService) UserCredentialsLdap(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsLdapOpts) (CredentialsLdap, *_nethttp.Response, error)

UserCredentialsLdap Get LDAP Credential ### LDAP login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsLdapOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsLdap

func (*UserApiService) UserCredentialsLookerOpenid 

func (a *UserApiService) UserCredentialsLookerOpenid(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsLookerOpenidOpts) (CredentialsLookerOpenid, *_nethttp.Response, error)

UserCredentialsLookerOpenid Get Looker OpenId Credential ### Looker Openid login information for the specified user. Used by Looker Analysts.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsLookerOpenidOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsLookerOpenid

func (*UserApiService) UserCredentialsOidc 

func (a *UserApiService) UserCredentialsOidc(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsOidcOpts) (CredentialsOidc, *_nethttp.Response, error)

UserCredentialsOidc Get OIDC Auth Credential ### OpenID Connect (OIDC) authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsOidcOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsOidc

func (*UserApiService) UserCredentialsSaml 

func (a *UserApiService) UserCredentialsSaml(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsSamlOpts) (CredentialsSaml, *_nethttp.Response, error)

UserCredentialsSaml Get Saml Auth Credential ### Saml authentication login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsSamlOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsSaml

func (*UserApiService) UserCredentialsTotp 

func (a *UserApiService) UserCredentialsTotp(ctx _context.Context, userId int64, localVarOptionals *UserCredentialsTotpOpts) (CredentialsTotp, *_nethttp.Response, error)

UserCredentialsTotp Get Two-Factor Credential ### Two-factor login information for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserCredentialsTotpOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return CredentialsTotp

func (*UserApiService) UserForCredential 

func (a *UserApiService) UserForCredential(ctx _context.Context, credentialType string, credentialId string, localVarOptionals *UserForCredentialOpts) (User, *_nethttp.Response, error)

UserForCredential Get User by Credential Id ### Get information about the user with a credential of given type with specific id. This is used to do things like find users by their embed external_user_id. Or, find the user with a given api3 client_id, etc. The &#39;credential_type&#39; matchs the &#39;type&#39; name of the various credential types. It must be one of the values listed in the table below. The &#39;credential_id&#39; is your unique Id for the user and is specific to each type of credential. An example using the Ruby sdk might look like: &#x60;sdk.user_for_credential(&#39;embed&#39;, &#39;customer-4959425&#39;)&#x60; This table shows the supported &#39;Credential Type&#39; strings. The right column is for reference; it shows which field in the given credential type is actually searched when finding a user with the supplied &#39;credential_id&#39;. | Credential Types | Id Field Matched | | ---------------- | ---------------- | | email | email | | google | google_user_id | | saml | saml_user_id | | oidc | oidc_user_id | | ldap | ldap_id | | api | token | | api3 | client_id | | embed | external_user_id | | looker_openid | email | NOTE: The &#39;api&#39; credential type was only used with the legacy Looker query API and is no longer supported. The credential type for API you are currently looking at is &#39;api3&#39;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param credentialType Type name of credential
  • @param credentialId Id of credential
  • @param optional nil or *UserForCredentialOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return User

func (*UserApiService) UserRoles 

func (a *UserApiService) UserRoles(ctx _context.Context, userId int64, localVarOptionals *UserRolesOpts) ([]Role, *_nethttp.Response, error)

UserRoles Get User Roles ### Get information about roles of a given user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId id of user
  • @param optional nil or *UserRolesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "DirectAssociationOnly" (optional.Bool) - Get only roles associated directly with the user: exclude those only associated through groups.

@return []Role

func (*UserApiService) UserSession 

func (a *UserApiService) UserSession(ctx _context.Context, userId int64, sessionId int64, localVarOptionals *UserSessionOpts) (Session, *_nethttp.Response, error)

UserSession Get Web Login Session ### Web login session for the specified user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId Id of user
  • @param sessionId Id of Web Login Session
  • @param optional nil or *UserSessionOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return Session

type UserAttribute 

type UserAttribute struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Name of user attribute
	Name string `json:"name,omitempty"`
	// Human-friendly label for user attribute
	Label string `json:"label,omitempty"`
	// Type of user attribute (\"string\", \"number\", \"datetime\", \"yesno\", \"zipcode\")
	Type string `json:"type,omitempty"`
	// Default value for when no value is set on the user
	DefaultValue string `json:"default_value,omitempty"`
	// Attribute is a system default
	IsSystem bool `json:"is_system,omitempty"`
	// Attribute is permanent and cannot be deleted
	IsPermanent bool `json:"is_permanent,omitempty"`
	// If true, users will not be able to view values of this attribute
	ValueIsHidden bool `json:"value_is_hidden,omitempty"`
	// Non-admin users can see the values of their attributes and use them in filters
	UserCanView bool `json:"user_can_view,omitempty"`
	// Users can change the value of this attribute for themselves
	UserCanEdit bool `json:"user_can_edit,omitempty"`
	// Destinations to which a hidden attribute may be sent. Once set, cannot be edited.
	HiddenValueDomainWhitelist string `json:"hidden_value_domain_whitelist,omitempty"`
}

UserAttribute struct for UserAttribute

type UserAttributeApiService 

type UserAttributeApiService service

UserAttributeApiService UserAttributeApi service

func (*UserAttributeApiService) AllUserAttributeGroupValues 

func (a *UserAttributeApiService) AllUserAttributeGroupValues(ctx _context.Context, userAttributeId int64, localVarOptionals *AllUserAttributeGroupValuesOpts) ([]UserAttributeGroupValue, *_nethttp.Response, error)

AllUserAttributeGroupValues Get User Attribute Group Values ### Returns all values of a user attribute defined by user groups, in precedence order. A user may be a member of multiple groups which define different values for a given user attribute. The order of group-values in the response determines precedence for selecting which group-value applies to a given user. For more information, see [Set User Attribute Group Values](#!/UserAttribute/set_user_attribute_group_values). Results will only include groups that the caller&#39;s user account has permission to see.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userAttributeId Id of user attribute
  • @param optional nil or *AllUserAttributeGroupValuesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return []UserAttributeGroupValue

func (*UserAttributeApiService) AllUserAttributes 

func (a *UserAttributeApiService) AllUserAttributes(ctx _context.Context, localVarOptionals *AllUserAttributesOpts) ([]UserAttribute, *_nethttp.Response, error)

AllUserAttributes Get All User Attributes ### Get information about all user attributes.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AllUserAttributesOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.
  • @param "Sorts" (optional.String) - Fields to order the results by. Sortable fields include: name, label

@return []UserAttribute

func (*UserAttributeApiService) CreateUserAttribute 

func (a *UserAttributeApiService) CreateUserAttribute(ctx _context.Context, body UserAttribute, localVarOptionals *CreateUserAttributeOpts) (UserAttribute, *_nethttp.Response, error)

CreateUserAttribute Create User Attribute ### Create a new user attribute Permission information for a user attribute is conveyed through the &#x60;can&#x60; and &#x60;user_can_edit&#x60; fields. The &#x60;user_can_edit&#x60; field indicates whether an attribute is user-editable _anywhere_ in the application. The &#x60;can&#x60; field gives more granular access information, with the &#x60;set_value&#x60; child field indicating whether an attribute&#39;s value can be set by [Setting the User Attribute User Value](#!/User/set_user_attribute_user_value). Note: &#x60;name&#x60; and &#x60;label&#x60; fields must be unique across all user attributes in the Looker instance. Attempting to create a new user attribute with a name or label that duplicates an existing user attribute will fail with a 422 error.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body User Attribute
  • @param optional nil or *CreateUserAttributeOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return UserAttribute

func (*UserAttributeApiService) DeleteUserAttribute 

func (a *UserAttributeApiService) DeleteUserAttribute(ctx _context.Context, userAttributeId int64) (string, *_nethttp.Response, error)

DeleteUserAttribute Delete User Attribute ### Delete a user attribute (admin only).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userAttributeId Id of user_attribute

@return string

func (*UserAttributeApiService) SetUserAttributeGroupValues 

func (a *UserAttributeApiService) SetUserAttributeGroupValues(ctx _context.Context, userAttributeId int64, body []UserAttributeGroupValue) ([]UserAttributeGroupValue, *_nethttp.Response, error)

SetUserAttributeGroupValues Set User Attribute Group Values ### Define values for a user attribute across a set of groups, in priority order. This function defines all values for a user attribute defined by user groups. This is a global setting, potentially affecting all users in the system. This function replaces any existing group value definitions for the indicated user attribute. The value of a user attribute for a given user is determined by searching the following locations, in this order: 1. the user&#39;s account settings 2. the groups that the user is a member of 3. the default value of the user attribute, if any The user may be a member of multiple groups which define different values for that user attribute. The order of items in the group_values parameter determines which group takes priority for that user. Lowest array index wins. An alternate method to indicate the selection precedence of group-values is to assign numbers to the &#39;rank&#39; property of each group-value object in the array. Lowest &#39;rank&#39; value wins. If you use this technique, you must assign a rank value to every group-value object in the array. To set a user attribute value for a single user, see [Set User Attribute User Value](#!/User/set_user_attribute_user_value). To set a user attribute value for all members of a group, see [Set User Attribute Group Value](#!/Group/update_user_attribute_group_value).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userAttributeId Id of user attribute
  • @param body Array of group values.

@return []UserAttributeGroupValue

func (*UserAttributeApiService) UpdateUserAttribute 

func (a *UserAttributeApiService) UpdateUserAttribute(ctx _context.Context, userAttributeId int64, body UserAttribute, localVarOptionals *UpdateUserAttributeOpts) (UserAttribute, *_nethttp.Response, error)

UpdateUserAttribute Update User Attribute ### Update a user attribute definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userAttributeId Id of user attribute
  • @param body User Attribute
  • @param optional nil or *UpdateUserAttributeOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return UserAttribute

func (*UserAttributeApiService) UserAttribute 

func (a *UserAttributeApiService) UserAttribute(ctx _context.Context, userAttributeId int64, localVarOptionals *UserAttributeOpts) (UserAttribute, *_nethttp.Response, error)

UserAttribute Get User Attribute ### Get information about a user attribute.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userAttributeId Id of user attribute
  • @param optional nil or *UserAttributeOpts - Optional Parameters:
  • @param "Fields" (optional.String) - Requested fields.

@return UserAttribute

type UserAttributeGroupValue 

type UserAttributeGroupValue struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id of this group-attribute relation
	Id int64 `json:"id,omitempty"`
	// Id of group
	GroupId int64 `json:"group_id,omitempty"`
	// Id of user attribute
	UserAttributeId int64 `json:"user_attribute_id,omitempty"`
	// If true, the \"value\" field will be null, because the attribute settings block access to this value
	ValueIsHidden bool `json:"value_is_hidden,omitempty"`
	// Precedence for resolving value for user
	Rank int64 `json:"rank,omitempty"`
	// Value of user attribute for group
	Value string `json:"value,omitempty"`
}

UserAttributeGroupValue struct for UserAttributeGroupValue

type UserAttributeOpts 

type UserAttributeOpts struct {
	Fields optional.String
}

UserAttributeOpts Optional parameters for the method 'UserAttribute'

type UserAttributeUserValuesOpts 

type UserAttributeUserValuesOpts struct {
	Fields           optional.String
	UserAttributeIds optional.Interface
	AllValues        optional.Bool
	IncludeUnset     optional.Bool
}

UserAttributeUserValuesOpts Optional parameters for the method 'UserAttributeUserValues'

type UserAttributeWithValue 

type UserAttributeWithValue struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Name of user attribute
	Name string `json:"name,omitempty"`
	// Human-friendly label for user attribute
	Label string `json:"label,omitempty"`
	// Precedence for setting value on user (lowest wins)
	Rank int64 `json:"rank,omitempty"`
	// Value of attribute for user
	Value string `json:"value,omitempty"`
	// Id of User
	UserId int64 `json:"user_id,omitempty"`
	// Can the user set this value
	UserCanEdit bool `json:"user_can_edit,omitempty"`
	// If true, the \"value\" field will be null, because the attribute settings block access to this value
	ValueIsHidden bool `json:"value_is_hidden,omitempty"`
	// Id of User Attribute
	UserAttributeId int64 `json:"user_attribute_id,omitempty"`
	// How user got this value for this attribute
	Source string `json:"source,omitempty"`
	// If this user attribute is hidden, whitelist of destinations to which it may be sent.
	HiddenValueDomainWhitelist string `json:"hidden_value_domain_whitelist,omitempty"`
}

UserAttributeWithValue struct for UserAttributeWithValue

type UserCredentialsApi3Opts 

type UserCredentialsApi3Opts struct {
	Fields optional.String
}

UserCredentialsApi3Opts Optional parameters for the method 'UserCredentialsApi3'

type UserCredentialsEmailOpts 

type UserCredentialsEmailOpts struct {
	Fields optional.String
}

UserCredentialsEmailOpts Optional parameters for the method 'UserCredentialsEmail'

type UserCredentialsEmbedOpts 

type UserCredentialsEmbedOpts struct {
	Fields optional.String
}

UserCredentialsEmbedOpts Optional parameters for the method 'UserCredentialsEmbed'

type UserCredentialsGoogleOpts 

type UserCredentialsGoogleOpts struct {
	Fields optional.String
}

UserCredentialsGoogleOpts Optional parameters for the method 'UserCredentialsGoogle'

type UserCredentialsLdapOpts 

type UserCredentialsLdapOpts struct {
	Fields optional.String
}

UserCredentialsLdapOpts Optional parameters for the method 'UserCredentialsLdap'

type UserCredentialsLookerOpenidOpts 

type UserCredentialsLookerOpenidOpts struct {
	Fields optional.String
}

UserCredentialsLookerOpenidOpts Optional parameters for the method 'UserCredentialsLookerOpenid'

type UserCredentialsOidcOpts 

type UserCredentialsOidcOpts struct {
	Fields optional.String
}

UserCredentialsOidcOpts Optional parameters for the method 'UserCredentialsOidc'

type UserCredentialsSamlOpts 

type UserCredentialsSamlOpts struct {
	Fields optional.String
}

UserCredentialsSamlOpts Optional parameters for the method 'UserCredentialsSaml'

type UserCredentialsTotpOpts 

type UserCredentialsTotpOpts struct {
	Fields optional.String
}

UserCredentialsTotpOpts Optional parameters for the method 'UserCredentialsTotp'

type UserForCredentialOpts 

type UserForCredentialOpts struct {
	Fields optional.String
}

UserForCredentialOpts Optional parameters for the method 'UserForCredential'

type UserIdOnly 

type UserIdOnly struct {
	// Unique Id
	Id int64 `json:"id,omitempty"`
}

UserIdOnly struct for UserIdOnly

type UserLoginLockout 

type UserLoginLockout struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Hash of user's client id
	Key string `json:"key,omitempty"`
	// Authentication method for login failures
	AuthType string `json:"auth_type,omitempty"`
	// IP address of most recent failed attempt
	Ip string `json:"ip,omitempty"`
	// User ID
	UserId int64 `json:"user_id,omitempty"`
	// Remote ID of user if using LDAP
	RemoteId string `json:"remote_id,omitempty"`
	// User's name
	FullName string `json:"full_name,omitempty"`
	// Email address associated with the user's account
	Email string `json:"email,omitempty"`
	// Number of failures that triggered the lockout
	FailCount int64 `json:"fail_count,omitempty"`
	// Time when lockout was triggered
	LockoutAt time.Time `json:"lockout_at,omitempty"`
}

UserLoginLockout struct for UserLoginLockout

type UserOpts 

type UserOpts struct {
	Fields optional.String
}

UserOpts Optional parameters for the method 'User'

type UserPublic 

type UserPublic struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// First Name
	FirstName string `json:"first_name,omitempty"`
	// Last Name
	LastName string `json:"last_name,omitempty"`
	// Full name for display (available only if both first_name and last_name are set)
	DisplayName string `json:"display_name,omitempty"`
	// URL for the avatar image (may be generic)
	AvatarUrl string `json:"avatar_url,omitempty"`
	// Link to get this item
	Url string `json:"url,omitempty"`
}

UserPublic struct for UserPublic

type UserRolesOpts 

type UserRolesOpts struct {
	Fields                optional.String
	DirectAssociationOnly optional.Bool
}

UserRolesOpts Optional parameters for the method 'UserRoles'

type UserSessionOpts 

type UserSessionOpts struct {
	Fields optional.String
}

UserSessionOpts Optional parameters for the method 'UserSession'

type ValidateProjectOpts 

type ValidateProjectOpts struct {
	Fields optional.String
}

ValidateProjectOpts Optional parameters for the method 'ValidateProject'

type ValidationError 

type ValidationError struct {
	// Error details
	Message string `json:"message"`
	// Error detail array
	Errors []ValidationErrorDetail `json:"errors,omitempty"`
	// Documentation link
	DocumentationUrl string `json:"documentation_url"`
}

ValidationError struct for ValidationError

type ValidationErrorDetail 

type ValidationErrorDetail struct {
	// Field with error
	Field string `json:"field,omitempty"`
	// Error code
	Code string `json:"code,omitempty"`
	// Error info message
	Message string `json:"message,omitempty"`
	// Documentation link
	DocumentationUrl string `json:"documentation_url"`
}

ValidationErrorDetail struct for ValidationErrorDetail

type VersionsOpts 

type VersionsOpts struct {
	Fields optional.String
}

VersionsOpts Optional parameters for the method 'Versions'

type WelcomeEmailTest 

type WelcomeEmailTest struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The content that will be sent as part of a custom welcome email
	Content string `json:"content,omitempty"`
}

WelcomeEmailTest struct for WelcomeEmailTest

type WhitelabelConfiguration 

type WhitelabelConfiguration struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// Unique Id
	Id int64 `json:"id,omitempty"`
	// Customer logo image. Expected base64 encoded data (write-only)
	LogoFile string `json:"logo_file,omitempty"`
	// Logo image url (read-only)
	LogoUrl string `json:"logo_url,omitempty"`
	// Custom favicon image. Expected base64 encoded data (write-only)
	FaviconFile string `json:"favicon_file,omitempty"`
	// Favicon image url (read-only)
	FaviconUrl string `json:"favicon_url,omitempty"`
	// Default page title
	DefaultTitle string `json:"default_title,omitempty"`
	// Boolean to toggle showing help menus
	ShowHelpMenu bool `json:"show_help_menu,omitempty"`
	// Boolean to toggle showing docs
	ShowDocs bool `json:"show_docs,omitempty"`
	// Boolean to toggle showing email subscription options.
	ShowEmailSubOptions bool `json:"show_email_sub_options,omitempty"`
	// Boolean to toggle mentions of Looker in emails
	AllowLookerMentions bool `json:"allow_looker_mentions,omitempty"`
	// Boolean to toggle links to Looker in emails
	AllowLookerLinks bool `json:"allow_looker_links,omitempty"`
}

WhitelabelConfiguration struct for WhitelabelConfiguration

type WhitelabelConfigurationOpts 

type WhitelabelConfigurationOpts struct {
	Fields optional.String
}

WhitelabelConfigurationOpts Optional parameters for the method 'WhitelabelConfiguration'

type Workspace 

type Workspace struct {
	// Operations the current user is able to perform on this object
	Can map[string]bool `json:"can,omitempty"`
	// The unique id of this user workspace. Predefined workspace ids include \"production\" and \"dev\"
	Id string `json:"id,omitempty"`
	// The local state of each project in the workspace
	Projects []Project `json:"projects,omitempty"`
}

Workspace struct for Workspace

type WorkspaceApiService 

type WorkspaceApiService service

WorkspaceApiService WorkspaceApi service

func (*WorkspaceApiService) AllWorkspaces 

func (a *WorkspaceApiService) AllWorkspaces(ctx _context.Context) ([]Workspace, *_nethttp.Response, error)

AllWorkspaces Get All Workspaces ### Get All Workspaces Returns all workspaces available to the calling user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Workspace

func (*WorkspaceApiService) Workspace 

func (a *WorkspaceApiService) Workspace(ctx _context.Context, workspaceId string) (Workspace, *_nethttp.Response, error)

Workspace Get Workspace ### Get A Workspace Returns information about a workspace such as the git status and selected branches of all projects available to the caller&#39;s user account. A workspace defines which versions of project files will be used to evaluate expressions and operations that use model definitions - operations such as running queries or rendering dashboards. Each project has its own git repository, and each project in a workspace may be configured to reference particular branch or revision within their respective repositories. There are two predefined workspaces available: \&quot;production\&quot; and \&quot;dev\&quot;. The production workspace is shared across all Looker users. Models in the production workspace are read-only. Changing files in production is accomplished by modifying files in a git branch and using Pull Requests to merge the changes from the dev branch into the production branch, and then telling Looker to sync with production. The dev workspace is local to each Looker user. Changes made to project/model files in the dev workspace only affect that user, and only when the dev workspace is selected as the active workspace for the API session. (See set_session_workspace()). The dev workspace is NOT unique to an API session. Two applications accessing the Looker API using the same user account will see the same files in the dev workspace. To avoid collisions between API clients it&#39;s best to have each client login with API3 credentials for a different user account. Changes made to files in a dev workspace are persistent across API sessions. It&#39;s a good idea to commit any changes you&#39;ve made to the git repository, but not strictly required. Your modified files reside in a special user-specific directory on the Looker server and will still be there when you login in again later and use update_session(workspace_id: \&quot;dev\&quot;) to select the dev workspace for the new API session.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workspaceId Id of the workspace

@return Workspace

type WriteScheduledPlan 

type WriteScheduledPlan struct {
	// Name of this scheduled plan
	Name string `json:"name,omitempty"`
	// User Id which owns this scheduled plan
	UserId int64 `json:"user_id,omitempty"`
	// Whether schedule is run as recipient (only applicable for email recipients)
	RunAsRecipient bool `json:"run_as_recipient,omitempty"`
	// Whether the ScheduledPlan is enabled
	Enabled bool `json:"enabled,omitempty"`
	// Id of a look
	LookId int64 `json:"look_id,omitempty"`
	// Id of a dashboard
	DashboardId int64 `json:"dashboard_id,omitempty"`
	// Id of a LookML dashboard
	LookmlDashboardId string `json:"lookml_dashboard_id,omitempty"`
	// Query string to run look or dashboard with
	FiltersString string `json:"filters_string,omitempty"`
	// (DEPRECATED) Alias for filters_string field
	DashboardFilters string `json:"dashboard_filters,omitempty"`
	// Delivery should occur if running the dashboard or look returns results
	RequireResults bool `json:"require_results,omitempty"`
	// Delivery should occur if the dashboard look does not return results
	RequireNoResults bool `json:"require_no_results,omitempty"`
	// Delivery should occur if data have changed since the last run
	RequireChange bool `json:"require_change,omitempty"`
	// Will run an unlimited query and send all results.
	SendAllResults bool `json:"send_all_results,omitempty"`
	// Vixie-Style crontab specification when to run
	Crontab string `json:"crontab,omitempty"`
	// Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string)
	Datagroup string `json:"datagroup,omitempty"`
	// Timezone for interpreting the specified crontab (default is Looker instance timezone)
	Timezone string `json:"timezone,omitempty"`
	// Query id
	QueryId string `json:"query_id,omitempty"`
	// Scheduled plan destinations
	ScheduledPlanDestination []ScheduledPlanDestination `json:"scheduled_plan_destination,omitempty"`
	// Whether the plan in question should only be run once (usually for testing)
	RunOnce bool `json:"run_once,omitempty"`
	// Whether links back to Looker should be included in this ScheduledPlan
	IncludeLinks bool `json:"include_links,omitempty"`
	// The size of paper a PDF should be rendered for
	PdfPaperSize string `json:"pdf_paper_size,omitempty"`
	// Whether the paper should be landscape
	PdfLandscape bool `json:"pdf_landscape,omitempty"`
	// Whether this schedule is in an embed context or not
	Embed bool `json:"embed,omitempty"`
	// Color scheme of the dashboard if applicable
	ColorTheme string `json:"color_theme,omitempty"`
	// Whether or not to expand table vis to full length
	LongTables bool `json:"long_tables,omitempty"`
}

WriteScheduledPlan struct for WriteScheduledPlan

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.