paginatedreport

package
v0.1.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2024 License: MIT Imports: 14 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 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"
	// 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"
	// ItemTypeMirroredWarehouse - A mirrored warehouse.
	ItemTypeMirroredWarehouse ItemType = "MirroredWarehouse"
	// ItemTypeNotebook - A notebook.
	ItemTypeNotebook ItemType = "Notebook"
	// ItemTypePaginatedReport - PowerBI paginated report.
	ItemTypePaginatedReport ItemType = "PaginatedReport"
	// 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) ListPaginatedReports 

func (client *ItemsClient) ListPaginatedReports(ctx context.Context, workspaceID string, options *ItemsClientListPaginatedReportsOptions) ([]PaginatedReport, error)

ListPaginatedReports - returns array of PaginatedReport 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] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes |

INTERFACE Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListPaginatedReportsOptions contains the optional parameters for the ItemsClient.NewListPaginatedReportsPager method.

func (*ItemsClient) NewListPaginatedReportsPager 

func (client *ItemsClient) NewListPaginatedReportsPager(workspaceID string, options *ItemsClientListPaginatedReportsOptions) *runtime.Pager[ItemsClientListPaginatedReportsResponse]

NewListPaginatedReportsPager - 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] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE

Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListPaginatedReportsOptions contains the optional parameters for the ItemsClient.NewListPaginatedReportsPager 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/paginatedreport"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := paginatedreport.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewItemsClient().NewListPaginatedReportsPager("cfafbeb1-8037-4d0c-896e-a46fb27ff229", &paginatedreport.ItemsClientListPaginatedReportsOptions{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.PaginatedReports = paginatedreport.PaginatedReports{
		// 	Value: []paginatedreport.PaginatedReport{
		// 		{
		// 			Type: to.Ptr(paginatedreport.ItemTypePaginatedReport),
		// 			Description: to.Ptr("A paginated report description."),
		// 			DisplayName: to.Ptr("PaginatedReport Name 1"),
		// 			ID: to.Ptr("3546052c-ae64-4526-b1a8-52af7761426f"),
		// 			WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
		// 	}},
		// }
	}
}

Output:

func (*ItemsClient) UpdatePaginatedReport 

func (client *ItemsClient) UpdatePaginatedReport(ctx context.Context, workspaceID string, paginatedReportID string, updatePaginatedReportRequest UpdatePaginatedReportRequest, options *ItemsClientUpdatePaginatedReportOptions) (ItemsClientUpdatePaginatedReportResponse, error)

UpdatePaginatedReport - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES PaginatedReport.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] | Yes | | 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.
  • paginatedReportID - The paginated report ID.
  • updatePaginatedReportRequest - Update paginated report request payload.
  • options - ItemsClientUpdatePaginatedReportOptions contains the optional parameters for the ItemsClient.UpdatePaginatedReport 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/paginatedreport"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := paginatedreport.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().UpdatePaginatedReport(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff233", "5b218778-e7a5-4d73-8187-f10824047731", paginatedreport.UpdatePaginatedReportRequest{
		Description: to.Ptr("A new description for paginated report."),
		DisplayName: to.Ptr("Paginated Report'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.PaginatedReport = paginatedreport.PaginatedReport{
	// 	Type: to.Ptr(paginatedreport.ItemTypePaginatedReport),
	// 	Description: to.Ptr("A new description for paginated report."),
	// 	DisplayName: to.Ptr("Paginated Report's New name"),
	// 	ID: to.Ptr("5b218778-e7a5-4d73-8187-f10824047731"),
	// 	WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff233"),
	// }
}

Output:

type ItemsClientListPaginatedReportsOptions 

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

ItemsClientListPaginatedReportsOptions contains the optional parameters for the ItemsClient.NewListPaginatedReportsPager method.

type ItemsClientListPaginatedReportsResponse 

type ItemsClientListPaginatedReportsResponse struct {
	// A list of paginated reports.
	PaginatedReports
}

ItemsClientListPaginatedReportsResponse contains the response from method ItemsClient.NewListPaginatedReportsPager.

type ItemsClientUpdatePaginatedReportOptions 

type ItemsClientUpdatePaginatedReportOptions struct {
}

ItemsClientUpdatePaginatedReportOptions contains the optional parameters for the ItemsClient.UpdatePaginatedReport method.

type ItemsClientUpdatePaginatedReportResponse 

type ItemsClientUpdatePaginatedReportResponse struct {
	// A paginated report object.
	PaginatedReport
}

ItemsClientUpdatePaginatedReportResponse contains the response from method ItemsClient.UpdatePaginatedReport.

type PaginatedReport 

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

	// The item description.
	Description *string

	// The item display name.
	DisplayName *string

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

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

PaginatedReport - A paginated report object.

func (PaginatedReport) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PaginatedReport.

func (*PaginatedReport) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PaginatedReport.

type PaginatedReports 

type PaginatedReports struct {
	// REQUIRED; A list of paginated reports.
	Value []PaginatedReport

	// 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
}

PaginatedReports - A list of paginated reports.

func (PaginatedReports) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PaginatedReports.

func (*PaginatedReports) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PaginatedReports.

type UpdatePaginatedReportRequest 

type UpdatePaginatedReportRequest struct {
	// The paginated report description. Maximum length is 256 characters.
	Description *string

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

UpdatePaginatedReportRequest - Update paginated report request.

func (UpdatePaginatedReportRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdatePaginatedReportRequest.

func (*UpdatePaginatedReportRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type UpdatePaginatedReportRequest.

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.