plannerplan

package
v0.20241004.1180715 Latest Latest
Warning

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

Go to latest
Published: Oct 4, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/me/beta/plannerplan Documentation

The plannerplan SDK allows for interaction with Microsoft Graph me (API Version beta).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/me/beta/plannerplan"

Client Initialization

client := plannerplan.NewPlannerPlanClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: PlannerPlanClient.CreatePlannerPlan

ctx := context.TODO()

payload := plannerplan.PlannerPlan{
	// ...
}


read, err := client.CreatePlannerPlan(ctx, payload, plannerplan.DefaultCreatePlannerPlanOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.CreatePlannerPlanArchive

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

payload := plannerplan.CreatePlannerPlanArchiveRequest{
	// ...
}


read, err := client.CreatePlannerPlanArchive(ctx, id, payload, plannerplan.DefaultCreatePlannerPlanArchiveOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.CreatePlannerPlanUnarchive

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

payload := plannerplan.CreatePlannerPlanUnarchiveRequest{
	// ...
}


read, err := client.CreatePlannerPlanUnarchive(ctx, id, payload, plannerplan.DefaultCreatePlannerPlanUnarchiveOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.DeletePlannerPlan

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

read, err := client.DeletePlannerPlan(ctx, id, plannerplan.DefaultDeletePlannerPlanOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.GetPlannerPlan

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

read, err := client.GetPlannerPlan(ctx, id, plannerplan.DefaultGetPlannerPlanOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.GetPlannerPlansCount

ctx := context.TODO()


read, err := client.GetPlannerPlansCount(ctx, plannerplan.DefaultGetPlannerPlansCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.ListPlannerPlans

ctx := context.TODO()


// alternatively `client.ListPlannerPlans(ctx, plannerplan.DefaultListPlannerPlansOperationOptions())` can be used to do batched pagination
items, err := client.ListPlannerPlansComplete(ctx, plannerplan.DefaultListPlannerPlansOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PlannerPlanClient.MovePlannerPlanToContainer

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

payload := plannerplan.MovePlannerPlanToContainerRequest{
	// ...
}


read, err := client.MovePlannerPlanToContainer(ctx, id, payload, plannerplan.DefaultMovePlannerPlanToContainerOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PlannerPlanClient.UpdatePlannerPlan

ctx := context.TODO()
id := plannerplan.NewMePlannerPlanID("plannerPlanId")

payload := plannerplan.PlannerPlan{
	// ...
}


read, err := client.UpdatePlannerPlan(ctx, id, payload, plannerplan.DefaultUpdatePlannerPlanOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreatePlannerPlanArchiveOperationOptions

type CreatePlannerPlanArchiveOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreatePlannerPlanArchiveOperationOptions

func DefaultCreatePlannerPlanArchiveOperationOptions() CreatePlannerPlanArchiveOperationOptions

func (CreatePlannerPlanArchiveOperationOptions) ToHeaders

func (CreatePlannerPlanArchiveOperationOptions) ToOData

func (CreatePlannerPlanArchiveOperationOptions) ToQuery

type CreatePlannerPlanArchiveOperationResponse

type CreatePlannerPlanArchiveOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreatePlannerPlanArchiveRequest

type CreatePlannerPlanArchiveRequest struct {
	Justification nullable.Type[string] `json:"justification,omitempty"`
}

type CreatePlannerPlanOperationOptions

type CreatePlannerPlanOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreatePlannerPlanOperationOptions

func DefaultCreatePlannerPlanOperationOptions() CreatePlannerPlanOperationOptions

func (CreatePlannerPlanOperationOptions) ToHeaders

func (CreatePlannerPlanOperationOptions) ToOData

func (CreatePlannerPlanOperationOptions) ToQuery

type CreatePlannerPlanOperationResponse

type CreatePlannerPlanOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.PlannerPlan
}

type CreatePlannerPlanUnarchiveOperationOptions

type CreatePlannerPlanUnarchiveOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreatePlannerPlanUnarchiveOperationOptions

func DefaultCreatePlannerPlanUnarchiveOperationOptions() CreatePlannerPlanUnarchiveOperationOptions

func (CreatePlannerPlanUnarchiveOperationOptions) ToHeaders

func (CreatePlannerPlanUnarchiveOperationOptions) ToOData

func (CreatePlannerPlanUnarchiveOperationOptions) ToQuery

type CreatePlannerPlanUnarchiveOperationResponse

type CreatePlannerPlanUnarchiveOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreatePlannerPlanUnarchiveRequest

type CreatePlannerPlanUnarchiveRequest struct {
	Justification nullable.Type[string] `json:"justification,omitempty"`
}

type DeletePlannerPlanOperationOptions

type DeletePlannerPlanOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeletePlannerPlanOperationOptions

func DefaultDeletePlannerPlanOperationOptions() DeletePlannerPlanOperationOptions

func (DeletePlannerPlanOperationOptions) ToHeaders

func (DeletePlannerPlanOperationOptions) ToOData

func (DeletePlannerPlanOperationOptions) ToQuery

type DeletePlannerPlanOperationResponse

type DeletePlannerPlanOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetPlannerPlanOperationOptions

type GetPlannerPlanOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetPlannerPlanOperationOptions

func DefaultGetPlannerPlanOperationOptions() GetPlannerPlanOperationOptions

func (GetPlannerPlanOperationOptions) ToHeaders

func (GetPlannerPlanOperationOptions) ToOData

func (GetPlannerPlanOperationOptions) ToQuery

type GetPlannerPlanOperationResponse

type GetPlannerPlanOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.PlannerPlan
}

type GetPlannerPlansCountOperationOptions

type GetPlannerPlansCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetPlannerPlansCountOperationOptions

func DefaultGetPlannerPlansCountOperationOptions() GetPlannerPlansCountOperationOptions

func (GetPlannerPlansCountOperationOptions) ToHeaders

func (GetPlannerPlansCountOperationOptions) ToOData

func (GetPlannerPlansCountOperationOptions) ToQuery

type GetPlannerPlansCountOperationResponse

type GetPlannerPlansCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListPlannerPlansCompleteResult

type ListPlannerPlansCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.PlannerPlan
}

type ListPlannerPlansCustomPager

type ListPlannerPlansCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}
func (p *ListPlannerPlansCustomPager) NextPageLink() *odata.Link

type ListPlannerPlansOperationOptions

type ListPlannerPlansOperationOptions struct {
	Count     *bool
	Expand    *odata.Expand
	Filter    *string
	Metadata  *odata.Metadata
	OrderBy   *odata.OrderBy
	RetryFunc client.RequestRetryFunc
	Search    *string
	Select    *[]string
	Skip      *int64
	Top       *int64
}

func DefaultListPlannerPlansOperationOptions

func DefaultListPlannerPlansOperationOptions() ListPlannerPlansOperationOptions

func (ListPlannerPlansOperationOptions) ToHeaders

func (ListPlannerPlansOperationOptions) ToOData

func (ListPlannerPlansOperationOptions) ToQuery

type ListPlannerPlansOperationResponse

type ListPlannerPlansOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.PlannerPlan
}

type MovePlannerPlanToContainerOperationOptions

type MovePlannerPlanToContainerOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultMovePlannerPlanToContainerOperationOptions

func DefaultMovePlannerPlanToContainerOperationOptions() MovePlannerPlanToContainerOperationOptions

func (MovePlannerPlanToContainerOperationOptions) ToHeaders

func (MovePlannerPlanToContainerOperationOptions) ToOData

func (MovePlannerPlanToContainerOperationOptions) ToQuery

type MovePlannerPlanToContainerOperationResponse

type MovePlannerPlanToContainerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.PlannerPlan
}

type MovePlannerPlanToContainerRequest

type MovePlannerPlanToContainerRequest struct {
	Container *beta.PlannerPlanContainer `json:"container,omitempty"`
}

type PlannerPlanClient

type PlannerPlanClient struct {
	Client *msgraph.Client
}

func NewPlannerPlanClientWithBaseURI

func NewPlannerPlanClientWithBaseURI(sdkApi sdkEnv.Api) (*PlannerPlanClient, error)

func (PlannerPlanClient) CreatePlannerPlan

CreatePlannerPlan - Create new navigation property to plans for me

func (PlannerPlanClient) CreatePlannerPlanArchive

CreatePlannerPlanArchive - Invoke action archive. Archive a plannerPlan object. Archiving a plan, also archives the plannerTasks and plannerBuckets in the plan. An archived entity is read-only. Archived entities cannot be updated. An archived plan can be unarchived. All archived entities can be deleted. Archived tasks are not included in the response for list of tasks assigned to a user.

func (PlannerPlanClient) CreatePlannerPlanUnarchive

CreatePlannerPlanUnarchive - Invoke action unarchive. Unarchive a plannerPlan object. Unarchiving a plan, also unarchives the plannerTasks and plannerBuckets in the plan. Only a plan that is archived can be unarchived.

func (PlannerPlanClient) DeletePlannerPlan

DeletePlannerPlan - Delete navigation property plans for me

func (PlannerPlanClient) GetPlannerPlan

GetPlannerPlan - Get plans from me

func (PlannerPlanClient) GetPlannerPlansCount

GetPlannerPlansCount - Get the number of the resource

func (PlannerPlanClient) ListPlannerPlans

ListPlannerPlans - List plans. Retrieve a list of plannerplan objects shared with a user object.

func (PlannerPlanClient) ListPlannerPlansComplete

ListPlannerPlansComplete retrieves all the results into a single object

func (PlannerPlanClient) ListPlannerPlansCompleteMatchingPredicate

func (c PlannerPlanClient) ListPlannerPlansCompleteMatchingPredicate(ctx context.Context, options ListPlannerPlansOperationOptions, predicate PlannerPlanOperationPredicate) (result ListPlannerPlansCompleteResult, err error)

ListPlannerPlansCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PlannerPlanClient) MovePlannerPlanToContainer

MovePlannerPlanToContainer - Invoke action moveToContainer. Move a planner plan object from one planner plan container to another. Planner plans can only be moved from a user container to a group container.

func (PlannerPlanClient) UpdatePlannerPlan

UpdatePlannerPlan - Update the navigation property plans in me

type PlannerPlanOperationPredicate

type PlannerPlanOperationPredicate struct {
}

func (PlannerPlanOperationPredicate) Matches

type UpdatePlannerPlanOperationOptions

type UpdatePlannerPlanOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdatePlannerPlanOperationOptions

func DefaultUpdatePlannerPlanOperationOptions() UpdatePlannerPlanOperationOptions

func (UpdatePlannerPlanOperationOptions) ToHeaders

func (UpdatePlannerPlanOperationOptions) ToOData

func (UpdatePlannerPlanOperationOptions) ToQuery

type UpdatePlannerPlanOperationResponse

type UpdatePlannerPlanOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL