plannerplan

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

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

The plannerplan SDK allows for interaction with Microsoft Graph groups (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/groups/beta/plannerplan"

Client Initialization

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

Example Usage: PlannerPlanClient.CreatePlannerPlan

ctx := context.TODO()
id := plannerplan.NewGroupID("groupId")

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


read, err := client.CreatePlannerPlan(ctx, id, 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.NewGroupIdPlannerPlanID("groupId", "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.NewGroupIdPlannerPlanID("groupId", "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.NewGroupIdPlannerPlanID("groupId", "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.NewGroupIdPlannerPlanID("groupId", "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()
id := plannerplan.NewGroupID("groupId")

read, err := client.GetPlannerPlansCount(ctx, id, 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()
id := plannerplan.NewGroupID("groupId")

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

Example Usage: PlannerPlanClient.MovePlannerPlanToContainer

ctx := context.TODO()
id := plannerplan.NewGroupIdPlannerPlanID("groupId", "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.NewGroupIdPlannerPlanID("groupId", "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 (o CreatePlannerPlanArchiveOperationOptions) ToHeaders() *client.Headers

func (CreatePlannerPlanArchiveOperationOptions) ToOData 

func (o CreatePlannerPlanArchiveOperationOptions) ToOData() *odata.Query

func (CreatePlannerPlanArchiveOperationOptions) ToQuery 

func (o CreatePlannerPlanArchiveOperationOptions) ToQuery() *client.QueryParams

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 (o CreatePlannerPlanOperationOptions) ToHeaders() *client.Headers

func (CreatePlannerPlanOperationOptions) ToOData 

func (o CreatePlannerPlanOperationOptions) ToOData() *odata.Query

func (CreatePlannerPlanOperationOptions) ToQuery 

func (o CreatePlannerPlanOperationOptions) ToQuery() *client.QueryParams

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 (o CreatePlannerPlanUnarchiveOperationOptions) ToHeaders() *client.Headers

func (CreatePlannerPlanUnarchiveOperationOptions) ToOData 

func (o CreatePlannerPlanUnarchiveOperationOptions) ToOData() *odata.Query

func (CreatePlannerPlanUnarchiveOperationOptions) ToQuery 

func (o CreatePlannerPlanUnarchiveOperationOptions) ToQuery() *client.QueryParams

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 (o DeletePlannerPlanOperationOptions) ToHeaders() *client.Headers

func (DeletePlannerPlanOperationOptions) ToOData 

func (o DeletePlannerPlanOperationOptions) ToOData() *odata.Query

func (DeletePlannerPlanOperationOptions) ToQuery 

func (o DeletePlannerPlanOperationOptions) ToQuery() *client.QueryParams

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 (o GetPlannerPlanOperationOptions) ToHeaders() *client.Headers

func (GetPlannerPlanOperationOptions) ToOData 

func (o GetPlannerPlanOperationOptions) ToOData() *odata.Query

func (GetPlannerPlanOperationOptions) ToQuery 

func (o GetPlannerPlanOperationOptions) ToQuery() *client.QueryParams

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 (o GetPlannerPlansCountOperationOptions) ToHeaders() *client.Headers

func (GetPlannerPlansCountOperationOptions) ToOData 

func (o GetPlannerPlansCountOperationOptions) ToOData() *odata.Query

func (GetPlannerPlansCountOperationOptions) ToQuery 

func (o GetPlannerPlansCountOperationOptions) ToQuery() *client.QueryParams

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 (o ListPlannerPlansOperationOptions) ToHeaders() *client.Headers

func (ListPlannerPlansOperationOptions) ToOData 

func (o ListPlannerPlansOperationOptions) ToOData() *odata.Query

func (ListPlannerPlansOperationOptions) ToQuery 

func (o ListPlannerPlansOperationOptions) ToQuery() *client.QueryParams

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 (o MovePlannerPlanToContainerOperationOptions) ToHeaders() *client.Headers

func (MovePlannerPlanToContainerOperationOptions) ToOData 

func (o MovePlannerPlanToContainerOperationOptions) ToOData() *odata.Query

func (MovePlannerPlanToContainerOperationOptions) ToQuery 

func (o MovePlannerPlanToContainerOperationOptions) ToQuery() *client.QueryParams

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 

func (c PlannerPlanClient) CreatePlannerPlan(ctx context.Context, id beta.GroupId, input beta.PlannerPlan, options CreatePlannerPlanOperationOptions) (result CreatePlannerPlanOperationResponse, err error)

CreatePlannerPlan - Create new navigation property to plans for groups

func (PlannerPlanClient) CreatePlannerPlanArchive 

func (c PlannerPlanClient) CreatePlannerPlanArchive(ctx context.Context, id beta.GroupIdPlannerPlanId, input CreatePlannerPlanArchiveRequest, options CreatePlannerPlanArchiveOperationOptions) (result CreatePlannerPlanArchiveOperationResponse, err error)

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 

func (c PlannerPlanClient) CreatePlannerPlanUnarchive(ctx context.Context, id beta.GroupIdPlannerPlanId, input CreatePlannerPlanUnarchiveRequest, options CreatePlannerPlanUnarchiveOperationOptions) (result CreatePlannerPlanUnarchiveOperationResponse, err error)

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 

func (c PlannerPlanClient) DeletePlannerPlan(ctx context.Context, id beta.GroupIdPlannerPlanId, options DeletePlannerPlanOperationOptions) (result DeletePlannerPlanOperationResponse, err error)

DeletePlannerPlan - Delete navigation property plans for groups

func (PlannerPlanClient) GetPlannerPlan 

func (c PlannerPlanClient) GetPlannerPlan(ctx context.Context, id beta.GroupIdPlannerPlanId, options GetPlannerPlanOperationOptions) (result GetPlannerPlanOperationResponse, err error)

GetPlannerPlan - Get plans from groups. Read-only. Nullable. Returns the plannerPlans owned by the group.

func (PlannerPlanClient) GetPlannerPlansCount 

func (c PlannerPlanClient) GetPlannerPlansCount(ctx context.Context, id beta.GroupId, options GetPlannerPlansCountOperationOptions) (result GetPlannerPlansCountOperationResponse, err error)

GetPlannerPlansCount - Get the number of the resource

func (PlannerPlanClient) ListPlannerPlans 

func (c PlannerPlanClient) ListPlannerPlans(ctx context.Context, id beta.GroupId, options ListPlannerPlansOperationOptions) (result ListPlannerPlansOperationResponse, err error)

ListPlannerPlans - List plans. Retrieve a list of plannerPlan objects owned by a group object.

func (PlannerPlanClient) ListPlannerPlansComplete 

func (c PlannerPlanClient) ListPlannerPlansComplete(ctx context.Context, id beta.GroupId, options ListPlannerPlansOperationOptions) (ListPlannerPlansCompleteResult, error)

ListPlannerPlansComplete retrieves all the results into a single object

func (PlannerPlanClient) ListPlannerPlansCompleteMatchingPredicate 

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

ListPlannerPlansCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PlannerPlanClient) MovePlannerPlanToContainer 

func (c PlannerPlanClient) MovePlannerPlanToContainer(ctx context.Context, id beta.GroupIdPlannerPlanId, input MovePlannerPlanToContainerRequest, options MovePlannerPlanToContainerOperationOptions) (result MovePlannerPlanToContainerOperationResponse, err error)

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 

func (c PlannerPlanClient) UpdatePlannerPlan(ctx context.Context, id beta.GroupIdPlannerPlanId, input beta.PlannerPlan, options UpdatePlannerPlanOperationOptions) (result UpdatePlannerPlanOperationResponse, err error)

UpdatePlannerPlan - Update the navigation property plans in groups

type PlannerPlanOperationPredicate 

type PlannerPlanOperationPredicate struct {
}

func (PlannerPlanOperationPredicate) Matches 

func (p PlannerPlanOperationPredicate) Matches(input beta.PlannerPlan) bool

type UpdatePlannerPlanOperationOptions 

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

func DefaultUpdatePlannerPlanOperationOptions 

func DefaultUpdatePlannerPlanOperationOptions() UpdatePlannerPlanOperationOptions

func (UpdatePlannerPlanOperationOptions) ToHeaders 

func (o UpdatePlannerPlanOperationOptions) ToHeaders() *client.Headers

func (UpdatePlannerPlanOperationOptions) ToOData 

func (o UpdatePlannerPlanOperationOptions) ToOData() *odata.Query

func (UpdatePlannerPlanOperationOptions) ToQuery 

func (o UpdatePlannerPlanOperationOptions) ToQuery() *client.QueryParams

type UpdatePlannerPlanOperationResponse 

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

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.