Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto PR: Regenerating the Go SDK (81a1c4856a670488bd5fe55eedbb9e4e8830d4a7) #1057

Merged
merged 1 commit into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@

## `github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/autonomousdatabasebackups` Documentation

The `autonomousdatabasebackups` SDK allows for interaction with the Azure Resource Manager Service `oracledatabase` (API Version `2024-06-01`).

This readme covers example usages, but further information on [using this SDK can be found in the project root](https://github.com/hashicorp/go-azure-sdk/tree/main/docs).

### Import Path

```go
import "github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/autonomousdatabasebackups"
```


### Client Initialization

```go
client := autonomousdatabasebackups.NewAutonomousDatabaseBackupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
```


### Example Usage: `AutonomousDatabaseBackupsClient.CreateOrUpdate`

```go
ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseValue", "autonomousDatabaseBackupValue")

payload := autonomousdatabasebackups.AutonomousDatabaseBackup{
// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
```


### Example Usage: `AutonomousDatabaseBackupsClient.Delete`

```go
ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseValue", "autonomousDatabaseBackupValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
```


### Example Usage: `AutonomousDatabaseBackupsClient.Get`

```go
ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseValue", "autonomousDatabaseBackupValue")

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


### Example Usage: `AutonomousDatabaseBackupsClient.ListByAutonomousDatabase`

```go
ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseValue")

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


### Example Usage: `AutonomousDatabaseBackupsClient.Update`

```go
ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseValue", "autonomousDatabaseBackupValue")

payload := autonomousdatabasebackups.AutonomousDatabaseBackupUpdate{
// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package autonomousdatabasebackups

import (
"fmt"

"github.com/hashicorp/go-azure-sdk/sdk/client/resourcemanager"
sdkEnv "github.com/hashicorp/go-azure-sdk/sdk/environments"
)

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See NOTICE.txt in the project root for license information.

type AutonomousDatabaseBackupsClient struct {
Client *resourcemanager.Client
}

func NewAutonomousDatabaseBackupsClientWithBaseURI(sdkApi sdkEnv.Api) (*AutonomousDatabaseBackupsClient, error) {
client, err := resourcemanager.NewResourceManagerClient(sdkApi, "autonomousdatabasebackups", defaultApiVersion)
if err != nil {
return nil, fmt.Errorf("instantiating AutonomousDatabaseBackupsClient: %+v", err)
}

return &AutonomousDatabaseBackupsClient{
Client: client,
}, nil
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
package autonomousdatabasebackups

import (
"encoding/json"
"fmt"
"strings"
)

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See NOTICE.txt in the project root for license information.

type AutonomousDatabaseBackupLifecycleState string

const (
AutonomousDatabaseBackupLifecycleStateActive AutonomousDatabaseBackupLifecycleState = "Active"
AutonomousDatabaseBackupLifecycleStateCreating AutonomousDatabaseBackupLifecycleState = "Creating"
AutonomousDatabaseBackupLifecycleStateDeleting AutonomousDatabaseBackupLifecycleState = "Deleting"
AutonomousDatabaseBackupLifecycleStateFailed AutonomousDatabaseBackupLifecycleState = "Failed"
AutonomousDatabaseBackupLifecycleStateUpdating AutonomousDatabaseBackupLifecycleState = "Updating"
)

func PossibleValuesForAutonomousDatabaseBackupLifecycleState() []string {
return []string{
string(AutonomousDatabaseBackupLifecycleStateActive),
string(AutonomousDatabaseBackupLifecycleStateCreating),
string(AutonomousDatabaseBackupLifecycleStateDeleting),
string(AutonomousDatabaseBackupLifecycleStateFailed),
string(AutonomousDatabaseBackupLifecycleStateUpdating),
}
}

func (s *AutonomousDatabaseBackupLifecycleState) UnmarshalJSON(bytes []byte) error {
var decoded string
if err := json.Unmarshal(bytes, &decoded); err != nil {
return fmt.Errorf("unmarshaling: %+v", err)
}
out, err := parseAutonomousDatabaseBackupLifecycleState(decoded)
if err != nil {
return fmt.Errorf("parsing %q: %+v", decoded, err)
}
*s = *out
return nil
}

func parseAutonomousDatabaseBackupLifecycleState(input string) (*AutonomousDatabaseBackupLifecycleState, error) {
vals := map[string]AutonomousDatabaseBackupLifecycleState{
"active": AutonomousDatabaseBackupLifecycleStateActive,
"creating": AutonomousDatabaseBackupLifecycleStateCreating,
"deleting": AutonomousDatabaseBackupLifecycleStateDeleting,
"failed": AutonomousDatabaseBackupLifecycleStateFailed,
"updating": AutonomousDatabaseBackupLifecycleStateUpdating,
}
if v, ok := vals[strings.ToLower(input)]; ok {
return &v, nil
}

// otherwise presume it's an undefined value and best-effort it
out := AutonomousDatabaseBackupLifecycleState(input)
return &out, nil
}

type AutonomousDatabaseBackupType string

const (
AutonomousDatabaseBackupTypeFull AutonomousDatabaseBackupType = "Full"
AutonomousDatabaseBackupTypeIncremental AutonomousDatabaseBackupType = "Incremental"
AutonomousDatabaseBackupTypeLongTerm AutonomousDatabaseBackupType = "LongTerm"
)

func PossibleValuesForAutonomousDatabaseBackupType() []string {
return []string{
string(AutonomousDatabaseBackupTypeFull),
string(AutonomousDatabaseBackupTypeIncremental),
string(AutonomousDatabaseBackupTypeLongTerm),
}
}

func (s *AutonomousDatabaseBackupType) UnmarshalJSON(bytes []byte) error {
var decoded string
if err := json.Unmarshal(bytes, &decoded); err != nil {
return fmt.Errorf("unmarshaling: %+v", err)
}
out, err := parseAutonomousDatabaseBackupType(decoded)
if err != nil {
return fmt.Errorf("parsing %q: %+v", decoded, err)
}
*s = *out
return nil
}

func parseAutonomousDatabaseBackupType(input string) (*AutonomousDatabaseBackupType, error) {
vals := map[string]AutonomousDatabaseBackupType{
"full": AutonomousDatabaseBackupTypeFull,
"incremental": AutonomousDatabaseBackupTypeIncremental,
"longterm": AutonomousDatabaseBackupTypeLongTerm,
}
if v, ok := vals[strings.ToLower(input)]; ok {
return &v, nil
}

// otherwise presume it's an undefined value and best-effort it
out := AutonomousDatabaseBackupType(input)
return &out, nil
}

type AzureResourceProvisioningState string

const (
AzureResourceProvisioningStateCanceled AzureResourceProvisioningState = "Canceled"
AzureResourceProvisioningStateFailed AzureResourceProvisioningState = "Failed"
AzureResourceProvisioningStateProvisioning AzureResourceProvisioningState = "Provisioning"
AzureResourceProvisioningStateSucceeded AzureResourceProvisioningState = "Succeeded"
)

func PossibleValuesForAzureResourceProvisioningState() []string {
return []string{
string(AzureResourceProvisioningStateCanceled),
string(AzureResourceProvisioningStateFailed),
string(AzureResourceProvisioningStateProvisioning),
string(AzureResourceProvisioningStateSucceeded),
}
}

func (s *AzureResourceProvisioningState) UnmarshalJSON(bytes []byte) error {
var decoded string
if err := json.Unmarshal(bytes, &decoded); err != nil {
return fmt.Errorf("unmarshaling: %+v", err)
}
out, err := parseAzureResourceProvisioningState(decoded)
if err != nil {
return fmt.Errorf("parsing %q: %+v", decoded, err)
}
*s = *out
return nil
}

func parseAzureResourceProvisioningState(input string) (*AzureResourceProvisioningState, error) {
vals := map[string]AzureResourceProvisioningState{
"canceled": AzureResourceProvisioningStateCanceled,
"failed": AzureResourceProvisioningStateFailed,
"provisioning": AzureResourceProvisioningStateProvisioning,
"succeeded": AzureResourceProvisioningStateSucceeded,
}
if v, ok := vals[strings.ToLower(input)]; ok {
return &v, nil
}

// otherwise presume it's an undefined value and best-effort it
out := AzureResourceProvisioningState(input)
return &out, nil
}
Loading
Loading