warehouse

package
v0.1.0-beta.11 Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2025 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientFactory 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(credential azcore.TokenCredential, endpoint *string, options *azcore.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • endpoint - pass nil to accept the default values.
  • options - pass nil to accept the default values.

func NewClientFactoryWithClient 

func NewClientFactoryWithClient(client fabric.Client) *ClientFactory

NewClientFactoryWithClient creates a new instance of ClientFactory with sharable Client. The Client will be propagated to any client created from this factory.

  • client - Client created in the containing module: github.com/microsoft/fabric-sdk-go/fabric

func (*ClientFactory) NewItemsClient 

func (c *ClientFactory) NewItemsClient() *ItemsClient

NewItemsClient creates a new instance of ItemsClient.

type CreateWarehouseRequest 

type CreateWarehouseRequest struct {
	// REQUIRED; The warehouse display name. The display name must follow naming rules according to item type.
	DisplayName *string

	// The warehouse description. Maximum length is 256 characters.
	Description *string
}

CreateWarehouseRequest - Create warehouse request payload.

func (CreateWarehouseRequest) MarshalJSON 

func (c CreateWarehouseRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CreateWarehouseRequest.

func (*CreateWarehouseRequest) UnmarshalJSON 

func (c *CreateWarehouseRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CreateWarehouseRequest.

type ItemType 

type ItemType string

ItemType - The type of the item. Additional item types may be added over time. 

const (
	// ItemTypeDashboard - PowerBI dashboard.
	ItemTypeDashboard ItemType = "Dashboard"
	// ItemTypeDataPipeline - A data pipeline.
	ItemTypeDataPipeline ItemType = "DataPipeline"
	// ItemTypeDatamart - PowerBI datamart.
	ItemTypeDatamart ItemType = "Datamart"
	// ItemTypeEnvironment - An environment.
	ItemTypeEnvironment ItemType = "Environment"
	// ItemTypeEventhouse - An eventhouse.
	ItemTypeEventhouse ItemType = "Eventhouse"
	// ItemTypeEventstream - An eventstream.
	ItemTypeEventstream ItemType = "Eventstream"
	// ItemTypeGraphQLAPI - An API for GraphQL item.
	ItemTypeGraphQLAPI ItemType = "GraphQLApi"
	// ItemTypeKQLDashboard - A KQL dashboard.
	ItemTypeKQLDashboard ItemType = "KQLDashboard"
	// ItemTypeKQLDatabase - A KQL database.
	ItemTypeKQLDatabase ItemType = "KQLDatabase"
	// ItemTypeKQLQueryset - A KQL queryset.
	ItemTypeKQLQueryset ItemType = "KQLQueryset"
	// ItemTypeLakehouse - A lakehouse.
	ItemTypeLakehouse ItemType = "Lakehouse"
	// ItemTypeMLExperiment - A machine learning experiment.
	ItemTypeMLExperiment ItemType = "MLExperiment"
	// ItemTypeMLModel - A machine learning model.
	ItemTypeMLModel ItemType = "MLModel"
	// ItemTypeMirroredDatabase - A mirrored database.
	ItemTypeMirroredDatabase ItemType = "MirroredDatabase"
	// ItemTypeMirroredWarehouse - A mirrored warehouse.
	ItemTypeMirroredWarehouse ItemType = "MirroredWarehouse"
	// ItemTypeNotebook - A notebook.
	ItemTypeNotebook ItemType = "Notebook"
	// ItemTypePaginatedReport - PowerBI paginated report.
	ItemTypePaginatedReport ItemType = "PaginatedReport"
	// ItemTypeReflex - A Reflex.
	ItemTypeReflex ItemType = "Reflex"
	// ItemTypeReport - PowerBI report.
	ItemTypeReport ItemType = "Report"
	// ItemTypeSQLEndpoint - An SQL endpoint.
	ItemTypeSQLEndpoint ItemType = "SQLEndpoint"
	// ItemTypeSemanticModel - PowerBI semantic model.
	ItemTypeSemanticModel ItemType = "SemanticModel"
	// ItemTypeSparkJobDefinition - A spark job definition.
	ItemTypeSparkJobDefinition ItemType = "SparkJobDefinition"
	// ItemTypeWarehouse - A warehouse.
	ItemTypeWarehouse ItemType = "Warehouse"
)

func PossibleItemTypeValues 

func PossibleItemTypeValues() []ItemType

PossibleItemTypeValues returns the possible values for the ItemType const type.

type ItemsClient 

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

ItemsClient contains the methods for the Items group. Don't use this type directly, use a constructor function instead.

func (*ItemsClient) BeginCreateWarehouse 

func (client *ItemsClient) BeginCreateWarehouse(ctx context.Context, workspaceID string, createWarehouseRequest CreateWarehouseRequest, options *ItemsClientBeginCreateWarehouseOptions) (*runtime.Poller[ItemsClientCreateWarehouseResponse], error)

BeginCreateWarehouse - This API supports long running operations (LRO) [/rest/api/fabric/articles/long-running-operation]. This API does not support create a warehouse with definition. PERMISSIONS THE CALLER MUST HAVE CONTRIBUTOR OR HIGHER WORKSPACE ROLE. REQUIRED DELEGATED SCOPES Warehouse.ReadWrite.All or Item.ReadWrite.All LIMITATIONS * To create a warehouse the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types [/fabric/enterprise/licenses#microsoft-fabric-license-types]. MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • createWarehouseRequest - Create item request payload.
  • options - ItemsClientBeginCreateWarehouseOptions contains the optional parameters for the ItemsClient.BeginCreateWarehouse method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/warehouse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := warehouse.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewItemsClient().BeginCreateWarehouse(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", warehouse.CreateWarehouseRequest{
		Description: to.Ptr("A warehouse description."),
		DisplayName: to.Ptr("Warehouse 1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*ItemsClient) CreateWarehouse 

func (client *ItemsClient) CreateWarehouse(ctx context.Context, workspaceID string, createWarehouseRequest CreateWarehouseRequest, options *ItemsClientBeginCreateWarehouseOptions) (ItemsClientCreateWarehouseResponse, error)

CreateWarehouse - returns ItemsClientCreateWarehouseResponse in sync mode. This API supports long running operations (LRO) [/rest/api/fabric/articles/long-running-operation].

This API does not support create a warehouse with definition.

PERMISSIONS THE CALLER MUST HAVE CONTRIBUTOR OR HIGHER WORKSPACE ROLE. REQUIRED DELEGATED SCOPES Warehouse.ReadWrite.All or Item.ReadWrite.All

LIMITATIONS

  • To create a warehouse the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types [/fabric/enterprise/licenses#microsoft-fabric-license-types].

MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section.

| Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes |

INTERFACE Generated from API version v1

  • workspaceID - The workspace ID.
  • createWarehouseRequest - Create item request payload.
  • options - ItemsClientBeginCreateWarehouseOptions contains the optional parameters for the ItemsClient.BeginCreateWarehouse method.

func (*ItemsClient) DeleteWarehouse 

func (client *ItemsClient) DeleteWarehouse(ctx context.Context, workspaceID string, warehouseID string, options *ItemsClientDeleteWarehouseOptions) (ItemsClientDeleteWarehouseResponse, error)

DeleteWarehouse - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES Warehouse.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • warehouseID - The warehouse ID.
  • options - ItemsClientDeleteWarehouseOptions contains the optional parameters for the ItemsClient.DeleteWarehouse method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/warehouse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := warehouse.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemsClient().DeleteWarehouse(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ItemsClient) GetWarehouse 

func (client *ItemsClient) GetWarehouse(ctx context.Context, workspaceID string, warehouseID string, options *ItemsClientGetWarehouseOptions) (ItemsClientGetWarehouseResponse, error)

GetWarehouse - PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES Warehouse.Read.All or Warehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • warehouseID - The warehouse ID.
  • options - ItemsClientGetWarehouseOptions contains the optional parameters for the ItemsClient.GetWarehouse method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/warehouse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := warehouse.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().GetWarehouse(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Warehouse = warehouse.Warehouse{
	// 	Type: to.Ptr(warehouse.ItemTypeWarehouse),
	// 	Description: to.Ptr("A warehouse description."),
	// 	DisplayName: to.Ptr("Warehouse 1"),
	// 	ID: to.Ptr("5b218778-e7a5-4d73-8187-f10824047715"),
	// 	WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
	// 	Properties: &warehouse.Properties{
	// 		ConnectionString: to.Ptr("qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-28T22:52:13.780Z"); return t}()),
	// 		LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-04T22:56:33.283Z"); return t}()),
	// 	},
	// }
}

Output:

func (*ItemsClient) ListWarehouses 

func (client *ItemsClient) ListWarehouses(ctx context.Context, workspaceID string, options *ItemsClientListWarehousesOptions) ([]Warehouse, error)

ListWarehouses - returns array of Warehouse from all pages. This API supports pagination [/rest/api/fabric/articles/pagination].

PERMISSIONS The caller must have viewer or higher workspace role.

REQUIRED DELEGATED SCOPES Workspace.Read.All or Workspace.ReadWrite.All

MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section.

| Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes |

INTERFACE Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListWarehousesOptions contains the optional parameters for the ItemsClient.NewListWarehousesPager method.

func (*ItemsClient) NewListWarehousesPager 

func (client *ItemsClient) NewListWarehousesPager(workspaceID string, options *ItemsClientListWarehousesOptions) *runtime.Pager[ItemsClientListWarehousesResponse]

NewListWarehousesPager - This API supports pagination [/rest/api/fabric/articles/pagination]. PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES Workspace.Read.All or Workspace.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE

Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListWarehousesOptions contains the optional parameters for the ItemsClient.NewListWarehousesPager method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/warehouse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := warehouse.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewItemsClient().NewListWarehousesPager("cfafbeb1-8037-4d0c-896e-a46fb27ff229", &warehouse.ItemsClientListWarehousesOptions{ContinuationToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.Warehouses = warehouse.Warehouses{
		// 	Value: []warehouse.Warehouse{
		// 		{
		// 			Type: to.Ptr(warehouse.ItemTypeWarehouse),
		// 			Description: to.Ptr("A warehouse description."),
		// 			DisplayName: to.Ptr("Warehouse Name 1"),
		// 			ID: to.Ptr("3546052c-ae64-4526-b1a8-52af7761426f"),
		// 			WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
		// 			Properties: &warehouse.Properties{
		// 				ConnectionString: to.Ptr("qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com"),
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-28T22:52:13.780Z"); return t}()),
		// 				LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-04T22:56:33.283Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Type: to.Ptr(warehouse.ItemTypeWarehouse),
		// 			Description: to.Ptr("A warehouse description."),
		// 			DisplayName: to.Ptr("Warehouse Name 2"),
		// 			ID: to.Ptr("6281bf94-81b9-46b2-b8d3-79bb868fc822"),
		// 			WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
		// 			Properties: &warehouse.Properties{
		// 				ConnectionString: to.Ptr("qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com"),
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-11-21T13:14:30.540Z"); return t}()),
		// 				LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-12-04T20:03:43.110Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*ItemsClient) UpdateWarehouse 

func (client *ItemsClient) UpdateWarehouse(ctx context.Context, workspaceID string, warehouseID string, updateWarehouseRequest UpdateWarehouseRequest, options *ItemsClientUpdateWarehouseOptions) (ItemsClientUpdateWarehouseResponse, error)

UpdateWarehouse - PERMISSIONS The caller must have contributor or higher workspce role. REQUIRED DELEGATED SCOPES Warehouse.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • warehouseID - The warehouse ID.
  • updateWarehouseRequest - Update warehouse request payload.
  • options - ItemsClientUpdateWarehouseOptions contains the optional parameters for the ItemsClient.UpdateWarehouse method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/warehouse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := warehouse.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().UpdateWarehouse(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", warehouse.UpdateWarehouseRequest{
		Description: to.Ptr("A new description for warehouse."),
		DisplayName: to.Ptr("Warehouse's New name"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Warehouse = warehouse.Warehouse{
	// 	Type: to.Ptr(warehouse.ItemTypeWarehouse),
	// 	Description: to.Ptr("A new description for warehouse."),
	// 	DisplayName: to.Ptr("Warehouse's New name"),
	// 	ID: to.Ptr("5b218778-e7a5-4d73-8187-f10824047715"),
	// 	WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
	// }
}

Output:

type ItemsClientBeginCreateWarehouseOptions 

type ItemsClientBeginCreateWarehouseOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ItemsClientBeginCreateWarehouseOptions contains the optional parameters for the ItemsClient.BeginCreateWarehouse method.

type ItemsClientCreateWarehouseResponse 

type ItemsClientCreateWarehouseResponse struct {
	// A warehouse object.
	Warehouse
}

ItemsClientCreateWarehouseResponse contains the response from method ItemsClient.BeginCreateWarehouse.

type ItemsClientDeleteWarehouseOptions 

type ItemsClientDeleteWarehouseOptions struct {
}

ItemsClientDeleteWarehouseOptions contains the optional parameters for the ItemsClient.DeleteWarehouse method.

type ItemsClientDeleteWarehouseResponse 

type ItemsClientDeleteWarehouseResponse struct {
}

ItemsClientDeleteWarehouseResponse contains the response from method ItemsClient.DeleteWarehouse.

type ItemsClientGetWarehouseOptions 

type ItemsClientGetWarehouseOptions struct {
}

ItemsClientGetWarehouseOptions contains the optional parameters for the ItemsClient.GetWarehouse method.

type ItemsClientGetWarehouseResponse 

type ItemsClientGetWarehouseResponse struct {
	// A warehouse object.
	Warehouse
}

ItemsClientGetWarehouseResponse contains the response from method ItemsClient.GetWarehouse.

type ItemsClientListWarehousesOptions 

type ItemsClientListWarehousesOptions struct {
	// A token for retrieving the next page of results.
	ContinuationToken *string
}

ItemsClientListWarehousesOptions contains the optional parameters for the ItemsClient.NewListWarehousesPager method.

type ItemsClientListWarehousesResponse 

type ItemsClientListWarehousesResponse struct {
	// A list of warehouses.
	Warehouses
}

ItemsClientListWarehousesResponse contains the response from method ItemsClient.NewListWarehousesPager.

type ItemsClientUpdateWarehouseOptions 

type ItemsClientUpdateWarehouseOptions struct {
}

ItemsClientUpdateWarehouseOptions contains the optional parameters for the ItemsClient.UpdateWarehouse method.

type ItemsClientUpdateWarehouseResponse 

type ItemsClientUpdateWarehouseResponse struct {
	// A warehouse object.
	Warehouse
}

ItemsClientUpdateWarehouseResponse contains the response from method ItemsClient.UpdateWarehouse.

type Properties 

type Properties struct {
	// REQUIRED; The SQL connection string connected to the workspace containing this warehouse.
	ConnectionString *string

	// REQUIRED; The date and time the warehouse was created.
	CreatedDate *time.Time

	// REQUIRED; The date and time the warehouse was last updated
	LastUpdatedTime *time.Time
}

Properties - The warehouse item properties.

func (Properties) MarshalJSON 

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Properties.

func (*Properties) UnmarshalJSON 

func (p *Properties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Properties.

type UpdateWarehouseRequest 

type UpdateWarehouseRequest struct {
	// The warehouse description. Maximum length is 256 characters.
	Description *string

	// The warehouse display name. The display name must follow naming rules according to item type.
	DisplayName *string
}

UpdateWarehouseRequest - Update warehouse request.

func (UpdateWarehouseRequest) MarshalJSON 

func (u UpdateWarehouseRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateWarehouseRequest.

func (*UpdateWarehouseRequest) UnmarshalJSON 

func (u *UpdateWarehouseRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateWarehouseRequest.

type Warehouse 

type Warehouse struct {
	// REQUIRED; The item type.
	Type *ItemType

	// The item description.
	Description *string

	// The item display name.
	DisplayName *string

	// The warehouse properties.
	Properties *Properties

	// READ-ONLY; The item ID.
	ID *string

	// READ-ONLY; The workspace ID.
	WorkspaceID *string
}

Warehouse - A warehouse object.

func (Warehouse) MarshalJSON 

func (w Warehouse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Warehouse.

func (*Warehouse) UnmarshalJSON 

func (w *Warehouse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Warehouse.

type Warehouses 

type Warehouses struct {
	// REQUIRED; A list of warehouses.
	Value []Warehouse

	// The token for the next result set batch. If there are no more records, it's removed from the response.
	ContinuationToken *string

	// The URI of the next result set batch. If there are no more records, it's removed from the response.
	ContinuationURI *string
}

Warehouses - A list of warehouses.

func (Warehouses) MarshalJSON 

func (w Warehouses) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Warehouses.

func (*Warehouses) UnmarshalJSON 

func (w *Warehouses) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Warehouses.

Source Files

View all Source files

Directories

Path Synopsis

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.