client

package
v1.11.0 Latest Latest
Warning

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

 Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 19 Imported by: 1

Documentation

Index

Constants

View Source 
const ApiVersion = "2023-04-10"
View Source 
const DefaultServerURL string = "https://cockroachlabs.cloud"

Variables

View Source 
var AllowedAWSEndpointConnectionStatusTypeEnumValues = []AWSEndpointConnectionStatusType{
	"PENDING",
	"PENDING_ACCEPTANCE",
	"AVAILABLE",
	"DELETING",
	"DELETED",
	"REJECTED",
	"FAILED",
	"EXPIRED",
}

All allowed values of AWSEndpointConnectionStatusType enum.

View Source 
var AllowedAuditLogActionEnumValues = []AuditLogAction{
	"AUDIT_LOG_ACTION_CREATE_CLUSTER",
	"AUDIT_LOG_ACTION_DELETE_CLUSTER",
	"AUDIT_LOG_ACTION_INVITE_USER_TO_ORGANIZATION",
	"AUDIT_LOG_ACTION_EDIT_USER_INVITE",
	"AUDIT_LOG_ACTION_REVOKE_USER_INVITE",
	"AUDIT_LOG_ACTION_ACCEPT_USER_INVITE",
	"AUDIT_LOG_ACTION_ASSIGN_USER_ROLE",
	"AUDIT_LOG_ACTION_DELETE_USER_FROM_ORGANIZATION",
	"AUDIT_LOG_ACTION_CREATE_SERVICE_ACCOUNT",
	"AUDIT_LOG_ACTION_UPDATE_SERVICE_ACCOUNT",
	"AUDIT_LOG_ACTION_DELETE_SERVICE_ACCOUNT",
	"AUDIT_LOG_ACTION_CREATE_API_KEY",
	"AUDIT_LOG_ACTION_UPDATE_API_KEY",
	"AUDIT_LOG_ACTION_DELETE_API_KEY",
	"AUDIT_LOG_ACTION_UPDATE_CLUSTER",
	"AUDIT_LOG_ACTION_CREATE_SQL_USER",
	"AUDIT_LOG_ACTION_CHANGE_SQL_USER_PASSWORD",
	"AUDIT_LOG_ACTION_DELETE_SQL_USER",
	"AUDIT_LOG_ACTION_ADD_IP_ALLOWLIST",
	"AUDIT_LOG_ACTION_EDIT_IP_ALLOWLIST",
	"AUDIT_LOG_ACTION_DELETE_IP_ALLOWLIST",
	"AUDIT_LOG_ACTION_CREATE_VPC_PEERING",
	"AUDIT_LOG_ACTION_DELETE_VPC_PEERING",
	"AUDIT_LOG_ACTION_CREATE_PRIVATE_LINK",
	"AUDIT_LOG_ACTION_ACCEPT_PRIVATE_LINK",
	"AUDIT_LOG_ACTION_REJECT_PRIVATE_LINK",
	"AUDIT_LOG_ACTION_USER_LOGIN",
	"AUDIT_LOG_ACTION_ADD_USER_TO_ROLE",
	"AUDIT_LOG_ACTION_REMOVE_USER_FROM_ROLE",
	"AUDIT_LOG_ACTION_CREATE_USER",
	"AUDIT_LOG_ACTION_DELETE_USER",
	"AUDIT_LOG_ACTION_UPDATE_USER",
	"AUDIT_LOG_ACTION_CREATE_GROUP",
	"AUDIT_LOG_ACTION_DELETE_GROUP",
	"AUDIT_LOG_ACTION_UPDATE_GROUP",
	"AUDIT_LOG_ACTION_SET_CLIENT_CA_CERT",
	"AUDIT_LOG_ACTION_UPDATE_CLIENT_CA_CERT",
	"AUDIT_LOG_ACTION_DELETE_CLIENT_CA_CERT",
	"AUDIT_LOG_ACTION_CREATE_API_OIDC_CONFIG",
	"AUDIT_LOG_ACTION_DELETE_API_OIDC_CONFIG",
	"AUDIT_LOG_ACTION_UPDATE_API_OIDC_CONFIG",
	"AUDIT_LOG_ACTION_CREATE_FOLDER",
	"AUDIT_LOG_ACTION_DELETE_FOLDER",
	"AUDIT_LOG_ACTION_UPDATE_FOLDER",
	"AUDIT_LOG_ACTION_ADD_PRIVATE_ENDPOINT_TRUSTED_OWNER",
	"AUDIT_LOG_ACTION_REMOVE_PRIVATE_ENDPOINT_TRUSTED_OWNER",
	"AUDIT_LOG_ACTION_ADD_ALERT_RECIPIENT",
	"AUDIT_LOG_ACTION_REMOVE_ALERT_RECIPIENT",
	"AUDIT_LOG_ACTION_TOGGLE_ALERTS",
	"AUDIT_LOG_ACTION_TEST_ALERT_EMAIL",
	"AUDIT_LOG_ACTION_UPDATE_CMEK",
	"AUDIT_LOG_ACTION_REVOKE_CMEK",
	"AUDIT_LOG_ACTION_UPDATE_CLUSTER_LOG_EXPORT",
	"AUDIT_LOG_ACTION_DELETE_CLUSTER_LOG_EXPORT",
	"AUDIT_LOG_ACTION_UPDATE_CLUSTER_METRIC_EXPORT",
	"AUDIT_LOG_ACTION_DELETE_CLUSTER_METRIC_EXPORT",
	"AUDIT_LOG_ACTION_RESTORE_CLUSTER",
	"AUDIT_LOG_ACTION_UPDATE_CLUSTER_MAJOR_VERSION",
	"AUDIT_LOG_ACTION_ROLLBACK_CLUSTER_MAJOR_VERSION_UPDATE",
	"AUDIT_LOG_ACTION_FINALIZE_CLUSTER_MAJOR_VERSION_UPDATE",
	"AUDIT_LOG_ACTION_UPDATE_CLUSTER_VERSION_UPGRADE_DEFERRAL",
	"AUDIT_LOG_ACTION_SET_CLUSTER_MAINTENANCE_WINDOW",
	"AUDIT_LOG_ACTION_DELETE_CLUSTER_MAINTENANCE_WINDOW",
	"AUDIT_LOG_ACTION_SET_EGRESS_TRAFFIC_POLICY",
	"AUDIT_LOG_ACTION_ADD_EGRESS_RULE",
	"AUDIT_LOG_ACTION_EDIT_EGRESS_RULE",
	"AUDIT_LOG_ACTION_DELETE_EGRESS_RULE",
	"AUDIT_LOG_ACTION_ENABLE_CLOUD_ORG_SSO",
	"AUDIT_LOG_ACTION_ADD_AUTHENTICATION_METHOD",
	"AUDIT_LOG_ACTION_UPDATE_AUTHENTICATION_METHOD",
	"AUDIT_LOG_ACTION_DELETE_AUTHENTICATION_METHOD",
}

All allowed values of AuditLogAction enum.

View Source 
var AllowedAuditLogSourceEnumValues = []AuditLogSource{
	"AUDIT_LOG_SOURCE_CC_API",
	"AUDIT_LOG_SOURCE_CLI",
	"AUDIT_LOG_SOURCE_UI",
	"AUDIT_LOG_SOURCE_INTERNAL",
}

All allowed values of AuditLogSource enum.

View Source 
var AllowedCMEKCustomerActionEnumValues = []CMEKCustomerAction{
	"REVOKE",
}

All allowed values of CMEKCustomerAction enum.

View Source 
var AllowedCMEKKeyTypeEnumValues = []CMEKKeyType{
	"AWS_KMS",
	"GCP_CLOUD_KMS",
	"NULL_KMS",
}

All allowed values of CMEKKeyType enum.

View Source 
var AllowedCMEKStatusEnumValues = []CMEKStatus{
	"DISABLED",
	"DISABLING",
	"DISABLE_FAILED",
	"ENABLED",
	"ENABLING",
	"ENABLE_FAILED",
	"ROTATING",
	"ROTATE_FAILED",
	"REVOKED",
	"REVOKING",
	"REVOKE_FAILED",
}

All allowed values of CMEKStatus enum.

View Source 
var AllowedClientCACertStatusEnumValues = []ClientCACertStatus{
	"NOT_SET",
	"IS_SET",
	"PENDING",
	"FAILED",
}

All allowed values of ClientCACertStatus enum.

View Source 
var AllowedCloudProviderTypeEnumValues = []CloudProviderType{
	"GCP",
	"AWS",
	"AZURE",
}

All allowed values of CloudProviderType enum.

View Source 
var AllowedClusterMajorVersionSupportStatusTypeEnumValues = []ClusterMajorVersionSupportStatusType{
	"UNSUPPORTED",
	"SUPPORTED",
	"PREVIEW",
}

All allowed values of ClusterMajorVersionSupportStatusType enum.

View Source 
var AllowedClusterStateTypeEnumValues = []ClusterStateType{
	"CREATING",
	"CREATED",
	"CREATION_FAILED",
	"DELETED",
	"LOCKED",
}

All allowed values of ClusterStateType enum.

View Source 
var AllowedClusterStatusTypeEnumValues = []ClusterStatusType{
	"UNSPECIFIED",
	"CRDB_MAJOR_UPGRADE_RUNNING",
	"CRDB_MAJOR_UPGRADE_FAILED",
	"CRDB_MAJOR_ROLLBACK_RUNNING",
	"CRDB_MAJOR_ROLLBACK_FAILED",
	"CRDB_PATCH_RUNNING",
	"CRDB_PATCH_FAILED",
	"CRDB_SCALE_RUNNING",
	"CRDB_SCALE_FAILED",
	"MAINTENANCE_RUNNING",
	"CRDB_INSTANCE_UPDATE_RUNNING",
	"CRDB_INSTANCE_UPDATE_FAILED",
	"CRDB_EDIT_CLUSTER_RUNNING",
	"CRDB_EDIT_CLUSTER_FAILED",
	"CRDB_CMEK_OPERATION_RUNNING",
	"CRDB_CMEK_OPERATION_FAILED",
	"TENANT_RESTORE_RUNNING",
	"TENANT_RESTORE_FAILED",
	"CRDB_LOG_EXPORT_OPERATION_RUNNING",
	"CRDB_LOG_EXPORT_OPERATION_FAILED",
	"CRDB_CLUSTER_DISRUPTION_RUNNING",
	"CRDB_CLUSTER_DISRUPTION_FAILED",
	"CRDB_REPAVE_RUNNING",
	"CRDB_REPAVE_FAILED",
	"CRDB_CUSTOM_CLIENT_CA_RUNNING",
	"CRDB_CUSTOM_CLIENT_CA_FAILED",
	"DEDICATED_FULL_CLUSTER_RESTORE_RUNNING",
	"DEDICATED_FULL_CLUSTER_RESTORE_FAILED",
}

All allowed values of ClusterStatusType enum.

View Source 
var AllowedClusterUpgradeStatusTypeEnumValues = []ClusterUpgradeStatusType{
	"FINALIZED",
	"MAJOR_UPGRADE_RUNNING",
	"UPGRADE_AVAILABLE",
	"PENDING_FINALIZATION",
	"ROLLBACK_RUNNING",
}

All allowed values of ClusterUpgradeStatusType enum.

View Source 
var AllowedClusterVersionDeferralPolicyTypeEnumValues = []ClusterVersionDeferralPolicyType{
	"NOT_DEFERRED",
	"FIXED_DEFERRAL",
}

All allowed values of ClusterVersionDeferralPolicyType enum.

View Source 
var AllowedCurrencyTypeEnumValues = []CurrencyType{
	"USD",
	"CRDB_CLOUD_CREDITS",
}

All allowed values of CurrencyType enum.

View Source 
var AllowedDatadogSiteTypeEnumValues = []DatadogSiteType{
	"US1",
	"US3",
	"US5",
	"US1_GOV",
	"EU1",
}

All allowed values of DatadogSiteType enum.

View Source 
var AllowedDeleteProtectionStateTypeEnumValues = []DeleteProtectionStateType{
	"ENABLED",
	"DISABLED",
}

All allowed values of DeleteProtectionStateType enum.

View Source 
var AllowedEgressTrafficPolicyTypeEnumValues = []EgressTrafficPolicyType{
	"UNSPECIFIED",
	"ERROR",
	"ALLOW_ALL",
	"DEFAULT_DENY",
	"UPDATING",
}

All allowed values of EgressTrafficPolicyType enum.

View Source 
var AllowedFolderResourceTypeTypeEnumValues = []FolderResourceTypeType{
	"FOLDER",
	"CLUSTER",
}

All allowed values of FolderResourceTypeType enum.

View Source 
var AllowedLogExportStatusEnumValues = []LogExportStatus{
	"DISABLED",
	"DISABLING",
	"DISABLE_FAILED",
	"ENABLED",
	"ENABLING",
	"ENABLE_FAILED",
	"CREDENTIALS_ERROR",
}

All allowed values of LogExportStatus enum.

View Source 
var AllowedLogExportTypeEnumValues = []LogExportType{
	"AWS_CLOUDWATCH",
	"GCP_CLOUD_LOGGING",
}

All allowed values of LogExportType enum.

View Source 
var AllowedLogLevelTypeEnumValues = []LogLevelType{
	"UNSPECIFIED",
	"WARNING",
	"ERROR",
	"FATAL",
}

All allowed values of LogLevelType enum.

View Source 
var AllowedMetricExportStatusTypeEnumValues = []MetricExportStatusType{
	"NOT_DEPLOYED",
	"DISABLING",
	"ENABLING",
	"ENABLED",
	"ERROR",
}

All allowed values of MetricExportStatusType enum.

View Source 
var AllowedNetworkVisibilityTypeEnumValues = []NetworkVisibilityType{
	"PUBLIC",
	"PRIVATE",
}

All allowed values of NetworkVisibilityType enum.

View Source 
var AllowedNodeStatusTypeEnumValues = []NodeStatusType{
	"LIVE",
	"NOT_READY",
}

All allowed values of NodeStatusType enum.

View Source 
var AllowedOperatingSystemTypeEnumValues = []OperatingSystemType{
	"MAC",
	"LINUX",
	"WINDOWS",
}

All allowed values of OperatingSystemType enum.

View Source 
var AllowedOrganizationUserRoleTypeEnumValues = []OrganizationUserRoleType{
	"BILLING_COORDINATOR",
	"ORG_ADMIN",
	"ORG_MEMBER",
	"CLUSTER_ADMIN",
	"CLUSTER_OPERATOR_WRITER",
	"CLUSTER_DEVELOPER",
	"CLUSTER_CREATOR",
	"FOLDER_ADMIN",
	"FOLDER_MOVER",
}

All allowed values of OrganizationUserRoleType enum.

View Source 
var AllowedPlanTypeEnumValues = []PlanType{
	"DEDICATED",
	"CUSTOM",
	"SERVERLESS",
}

All allowed values of PlanType enum.

View Source 
var AllowedPrivateEndpointConnectionStatusEnumValues = []PrivateEndpointConnectionStatus{
	"STATUS_PENDING",
	"STATUS_PENDING_ACCEPTANCE",
	"STATUS_AVAILABLE",
	"STATUS_DELETING",
	"STATUS_DELETED",
	"STATUS_REJECTED",
	"STATUS_FAILED",
	"STATUS_EXPIRED",
}

All allowed values of PrivateEndpointConnectionStatus enum.

View Source 
var AllowedPrivateEndpointServiceStatusTypeEnumValues = []PrivateEndpointServiceStatusType{
	"CREATING",
	"AVAILABLE",
	"CREATE_FAILED",
	"DELETING",
	"DELETE_FAILED",
}

All allowed values of PrivateEndpointServiceStatusType enum.

View Source 
var AllowedPrivateEndpointTrustedOwnerTypeTypeEnumValues = []PrivateEndpointTrustedOwnerTypeType{
	"AWS_ACCOUNT_ID",
}

All allowed values of PrivateEndpointTrustedOwnerTypeType enum.

View Source 
var AllowedQuantityUnitTypeEnumValues = []QuantityUnitType{
	"HOURS",
	"REQUEST_UNITS",
}

All allowed values of QuantityUnitType enum.

View Source 
var AllowedResourceTypeTypeEnumValues = []ResourceTypeType{
	"ORGANIZATION",
	"CLUSTER",
	"FOLDER",
}

All allowed values of ResourceTypeType enum.

View Source 
var AllowedSetAWSEndpointConnectionStatusTypeEnumValues = []SetAWSEndpointConnectionStatusType{
	"AVAILABLE",
	"REJECTED",
}

All allowed values of SetAWSEndpointConnectionStatusType enum.

View Source 
var AllowedSortOrderEnumValues = []SortOrder{
	"ASC",
	"DESC",
}

All allowed values of SortOrder enum.

Functions

This section is empty.

Types

type AWSEndpointConnectionStatusType added in v1.0.0 

type AWSEndpointConnectionStatusType string

AWSEndpointConnectionStatusType the model 'AWSEndpointConnectionStatusType'. 

const (
	AWSENDPOINTCONNECTIONSTATUSTYPE_PENDING            AWSEndpointConnectionStatusType = "PENDING"
	AWSENDPOINTCONNECTIONSTATUSTYPE_PENDING_ACCEPTANCE AWSEndpointConnectionStatusType = "PENDING_ACCEPTANCE"
	AWSENDPOINTCONNECTIONSTATUSTYPE_AVAILABLE          AWSEndpointConnectionStatusType = "AVAILABLE"
	AWSENDPOINTCONNECTIONSTATUSTYPE_DELETING           AWSEndpointConnectionStatusType = "DELETING"
	AWSENDPOINTCONNECTIONSTATUSTYPE_DELETED            AWSEndpointConnectionStatusType = "DELETED"
	AWSENDPOINTCONNECTIONSTATUSTYPE_REJECTED           AWSEndpointConnectionStatusType = "REJECTED"
	AWSENDPOINTCONNECTIONSTATUSTYPE_FAILED             AWSEndpointConnectionStatusType = "FAILED"
	AWSENDPOINTCONNECTIONSTATUSTYPE_EXPIRED            AWSEndpointConnectionStatusType = "EXPIRED"
)

List of AWSEndpointConnectionStatus.Type.

func NewAWSEndpointConnectionStatusTypeFromValue added in v1.0.0 

func NewAWSEndpointConnectionStatusTypeFromValue(v string) (*AWSEndpointConnectionStatusType, error)

NewAWSEndpointConnectionStatusTypeFromValue returns a pointer to a valid AWSEndpointConnectionStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AWSEndpointConnectionStatusType) IsValid added in v1.0.0 

func (v AWSEndpointConnectionStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AWSEndpointConnectionStatusType) Ptr added in v1.0.0 

func (v AWSEndpointConnectionStatusType) Ptr() *AWSEndpointConnectionStatusType

Ptr returns reference to AWSEndpointConnectionStatus.Type value.

type AWSPrivateLinkServiceDetail 

type AWSPrivateLinkServiceDetail struct {
	// availability_zone_ids are the identifiers for the availability zones that the service is available in.
	AvailabilityZoneIds []string `json:"availability_zone_ids"`
	// service_id is the server side of the PrivateLink connection. This is the same as AWSPrivateLinkEndpoint.service_id.
	ServiceId string `json:"service_id"`
	// service_name is the AWS service name customers use to create endpoints on their end.
	ServiceName string `json:"service_name"`
}

AWSPrivateLinkServiceDetail struct for AWSPrivateLinkServiceDetail.

func NewAWSPrivateLinkServiceDetail 

func NewAWSPrivateLinkServiceDetail(availabilityZoneIds []string, serviceId string, serviceName string) *AWSPrivateLinkServiceDetail

NewAWSPrivateLinkServiceDetail instantiates a new AWSPrivateLinkServiceDetail object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAWSPrivateLinkServiceDetailWithDefaults 

func NewAWSPrivateLinkServiceDetailWithDefaults() *AWSPrivateLinkServiceDetail

NewAWSPrivateLinkServiceDetailWithDefaults instantiates a new AWSPrivateLinkServiceDetail object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AWSPrivateLinkServiceDetail) GetAvailabilityZoneIds 

func (o *AWSPrivateLinkServiceDetail) GetAvailabilityZoneIds() []string

GetAvailabilityZoneIds returns the AvailabilityZoneIds field value.

func (*AWSPrivateLinkServiceDetail) GetServiceId 

func (o *AWSPrivateLinkServiceDetail) GetServiceId() string

GetServiceId returns the ServiceId field value.

func (*AWSPrivateLinkServiceDetail) GetServiceName 

func (o *AWSPrivateLinkServiceDetail) GetServiceName() string

GetServiceName returns the ServiceName field value.

func (*AWSPrivateLinkServiceDetail) SetAvailabilityZoneIds 

func (o *AWSPrivateLinkServiceDetail) SetAvailabilityZoneIds(v []string)

SetAvailabilityZoneIds sets field value.

func (*AWSPrivateLinkServiceDetail) SetServiceId 

func (o *AWSPrivateLinkServiceDetail) SetServiceId(v string)

SetServiceId sets field value.

func (*AWSPrivateLinkServiceDetail) SetServiceName 

func (o *AWSPrivateLinkServiceDetail) SetServiceName(v string)

SetServiceName sets field value.

type AddEgressRuleRequest added in v0.3.3 

type AddEgressRuleRequest struct {
	// description is text that serves to document the rules purpose.
	Description string `json:"description"`
	// destination is the endpoint (or subnetwork if CIDR) to which traffic is allowed.
	Destination string `json:"destination"`
	// idempotency_key uniquely identifies this request. If not set, it will be set by the server.
	IdempotencyKey *string `json:"idempotency_key,omitempty"`
	// name is the name of the egress rule.
	Name string `json:"name"`
	// Deprecated: This field is ignored and will be removed in the next version. paths are the allowed URL paths. If empty, all paths are allowed. Only valid if Type=\"FQDN\".
	Paths *[]string `json:"paths,omitempty"`
	// ports are the allowed ports for TCP protocol. If Empty, all ports are allowed.
	Ports *[]int32 `json:"ports,omitempty"`
	// type classifies the Destination field. Valid types include: \"FQDN\", \"CIDR\".
	Type string `json:"type"`
}

AddEgressRuleRequest AddEgressRuleRequest is the input for the rpc AddEgressRule()..

func NewAddEgressRuleRequest added in v0.3.3 

func NewAddEgressRuleRequest(description string, destination string, name string, type_ string) *AddEgressRuleRequest

NewAddEgressRuleRequest instantiates a new AddEgressRuleRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddEgressRuleRequestWithDefaults added in v0.3.3 

func NewAddEgressRuleRequestWithDefaults() *AddEgressRuleRequest

NewAddEgressRuleRequestWithDefaults instantiates a new AddEgressRuleRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddEgressRuleRequest) GetDescription added in v0.3.3 

func (o *AddEgressRuleRequest) GetDescription() string

GetDescription returns the Description field value.

func (*AddEgressRuleRequest) GetDestination added in v0.3.3 

func (o *AddEgressRuleRequest) GetDestination() string

GetDestination returns the Destination field value.

func (*AddEgressRuleRequest) GetIdempotencyKey added in v0.3.3 

func (o *AddEgressRuleRequest) GetIdempotencyKey() string

GetIdempotencyKey returns the IdempotencyKey field value if set, zero value otherwise.

func (*AddEgressRuleRequest) GetName added in v0.3.3 

func (o *AddEgressRuleRequest) GetName() string

GetName returns the Name field value.

func (*AddEgressRuleRequest) GetPaths added in v0.3.3 

func (o *AddEgressRuleRequest) GetPaths() []string

GetPaths returns the Paths field value if set, zero value otherwise.

func (*AddEgressRuleRequest) GetPorts added in v0.3.3 

func (o *AddEgressRuleRequest) GetPorts() []int32

GetPorts returns the Ports field value if set, zero value otherwise.

func (*AddEgressRuleRequest) GetType added in v0.3.3 

func (o *AddEgressRuleRequest) GetType() string

GetType returns the Type field value.

func (*AddEgressRuleRequest) SetDescription added in v0.3.3 

func (o *AddEgressRuleRequest) SetDescription(v string)

SetDescription sets field value.

func (*AddEgressRuleRequest) SetDestination added in v0.3.3 

func (o *AddEgressRuleRequest) SetDestination(v string)

SetDestination sets field value.

func (*AddEgressRuleRequest) SetIdempotencyKey added in v0.3.3 

func (o *AddEgressRuleRequest) SetIdempotencyKey(v string)

SetIdempotencyKey gets a reference to the given string and assigns it to the IdempotencyKey field.

func (*AddEgressRuleRequest) SetName added in v0.3.3 

func (o *AddEgressRuleRequest) SetName(v string)

SetName sets field value.

func (*AddEgressRuleRequest) SetPaths added in v0.3.3 

func (o *AddEgressRuleRequest) SetPaths(v []string)

SetPaths gets a reference to the given []string and assigns it to the Paths field.

func (*AddEgressRuleRequest) SetPorts added in v0.3.3 

func (o *AddEgressRuleRequest) SetPorts(v []int32)

SetPorts gets a reference to the given []int32 and assigns it to the Ports field.

func (*AddEgressRuleRequest) SetType added in v0.3.3 

func (o *AddEgressRuleRequest) SetType(v string)

SetType sets field value.

type AddEgressRuleResponse added in v0.3.3 

type AddEgressRuleResponse struct {
	Rule *EgressRule `json:"Rule,omitempty"`
}

AddEgressRuleResponse AddEgressRuleResponse is the response message of the AddEgressRule RPC..

func NewAddEgressRuleResponse added in v0.3.3 

func NewAddEgressRuleResponse() *AddEgressRuleResponse

NewAddEgressRuleResponse instantiates a new AddEgressRuleResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*AddEgressRuleResponse) GetRule added in v0.3.3 

func (o *AddEgressRuleResponse) GetRule() EgressRule

GetRule returns the Rule field value if set, zero value otherwise.

func (*AddEgressRuleResponse) SetRule added in v0.3.3 

func (o *AddEgressRuleResponse) SetRule(v EgressRule)

SetRule gets a reference to the given EgressRule and assigns it to the Rule field.

type AddPrivateEndpointConnectionRequest added in v1.8.0 

type AddPrivateEndpointConnectionRequest struct {
	// endpoint_id is the id of the private endpoint associated with a cluster's private endpoint service. The private endpoint is customer-created and its id is generated by the cloud provider at endpoint creation time.
	EndpointId string `json:"endpoint_id"`
}

AddPrivateEndpointConnectionRequest struct for AddPrivateEndpointConnectionRequest.

func NewAddPrivateEndpointConnectionRequest added in v1.8.0 

func NewAddPrivateEndpointConnectionRequest(endpointId string) *AddPrivateEndpointConnectionRequest

NewAddPrivateEndpointConnectionRequest instantiates a new AddPrivateEndpointConnectionRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddPrivateEndpointConnectionRequestWithDefaults added in v1.8.0 

func NewAddPrivateEndpointConnectionRequestWithDefaults() *AddPrivateEndpointConnectionRequest

NewAddPrivateEndpointConnectionRequestWithDefaults instantiates a new AddPrivateEndpointConnectionRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddPrivateEndpointConnectionRequest) GetEndpointId added in v1.8.0 

func (o *AddPrivateEndpointConnectionRequest) GetEndpointId() string

GetEndpointId returns the EndpointId field value.

func (*AddPrivateEndpointConnectionRequest) SetEndpointId added in v1.8.0 

func (o *AddPrivateEndpointConnectionRequest) SetEndpointId(v string)

SetEndpointId sets field value.

type AddPrivateEndpointTrustedOwnerRequest added in v1.8.0 

type AddPrivateEndpointTrustedOwnerRequest struct {
	// external_owner_id is the identifier of the owner within the cloud provider for private endpoint connections. A wildcard character (\"*\") can be used to denote all owners.
	ExternalOwnerId string                              `json:"external_owner_id"`
	Type            PrivateEndpointTrustedOwnerTypeType `json:"type"`
}

AddPrivateEndpointTrustedOwnerRequest struct for AddPrivateEndpointTrustedOwnerRequest.

func NewAddPrivateEndpointTrustedOwnerRequest added in v1.8.0 

func NewAddPrivateEndpointTrustedOwnerRequest(externalOwnerId string, type_ PrivateEndpointTrustedOwnerTypeType) *AddPrivateEndpointTrustedOwnerRequest

NewAddPrivateEndpointTrustedOwnerRequest instantiates a new AddPrivateEndpointTrustedOwnerRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddPrivateEndpointTrustedOwnerRequestWithDefaults added in v1.8.0 

func NewAddPrivateEndpointTrustedOwnerRequestWithDefaults() *AddPrivateEndpointTrustedOwnerRequest

NewAddPrivateEndpointTrustedOwnerRequestWithDefaults instantiates a new AddPrivateEndpointTrustedOwnerRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddPrivateEndpointTrustedOwnerRequest) GetExternalOwnerId added in v1.8.0 

func (o *AddPrivateEndpointTrustedOwnerRequest) GetExternalOwnerId() string

GetExternalOwnerId returns the ExternalOwnerId field value.

func (*AddPrivateEndpointTrustedOwnerRequest) GetType added in v1.8.0 

func (o *AddPrivateEndpointTrustedOwnerRequest) GetType() PrivateEndpointTrustedOwnerTypeType

GetType returns the Type field value.

func (*AddPrivateEndpointTrustedOwnerRequest) SetExternalOwnerId added in v1.8.0 

func (o *AddPrivateEndpointTrustedOwnerRequest) SetExternalOwnerId(v string)

SetExternalOwnerId sets field value.

func (*AddPrivateEndpointTrustedOwnerRequest) SetType added in v1.8.0 

func (o *AddPrivateEndpointTrustedOwnerRequest) SetType(v PrivateEndpointTrustedOwnerTypeType)

SetType sets field value.

type AddPrivateEndpointTrustedOwnerResponse added in v1.6.0 

type AddPrivateEndpointTrustedOwnerResponse struct {
	TrustedOwner PrivateEndpointTrustedOwner `json:"trusted_owner"`
}

AddPrivateEndpointTrustedOwnerResponse struct for AddPrivateEndpointTrustedOwnerResponse.

func NewAddPrivateEndpointTrustedOwnerResponse added in v1.6.0 

func NewAddPrivateEndpointTrustedOwnerResponse(trustedOwner PrivateEndpointTrustedOwner) *AddPrivateEndpointTrustedOwnerResponse

NewAddPrivateEndpointTrustedOwnerResponse instantiates a new AddPrivateEndpointTrustedOwnerResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAddPrivateEndpointTrustedOwnerResponseWithDefaults added in v1.6.0 

func NewAddPrivateEndpointTrustedOwnerResponseWithDefaults() *AddPrivateEndpointTrustedOwnerResponse

NewAddPrivateEndpointTrustedOwnerResponseWithDefaults instantiates a new AddPrivateEndpointTrustedOwnerResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AddPrivateEndpointTrustedOwnerResponse) GetTrustedOwner added in v1.6.0 

func (o *AddPrivateEndpointTrustedOwnerResponse) GetTrustedOwner() PrivateEndpointTrustedOwner

GetTrustedOwner returns the TrustedOwner field value.

func (*AddPrivateEndpointTrustedOwnerResponse) SetTrustedOwner added in v1.6.0 

func (o *AddPrivateEndpointTrustedOwnerResponse) SetTrustedOwner(v PrivateEndpointTrustedOwner)

SetTrustedOwner sets field value.

type AllowlistEntry 

type AllowlistEntry struct {
	CidrIp   string  `json:"cidr_ip"`
	CidrMask int32   `json:"cidr_mask"`
	Name     *string `json:"name,omitempty"`
	Sql      bool    `json:"sql"`
	Ui       bool    `json:"ui"`
}

AllowlistEntry struct for AllowlistEntry.

func NewAllowlistEntry 

func NewAllowlistEntry(cidrIp string, cidrMask int32, sql bool, ui bool) *AllowlistEntry

NewAllowlistEntry instantiates a new AllowlistEntry object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAllowlistEntryWithDefaults 

func NewAllowlistEntryWithDefaults() *AllowlistEntry

NewAllowlistEntryWithDefaults instantiates a new AllowlistEntry object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AllowlistEntry) GetCidrIp 

func (o *AllowlistEntry) GetCidrIp() string

GetCidrIp returns the CidrIp field value.

func (*AllowlistEntry) GetCidrMask 

func (o *AllowlistEntry) GetCidrMask() int32

GetCidrMask returns the CidrMask field value.

func (*AllowlistEntry) GetName 

func (o *AllowlistEntry) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*AllowlistEntry) GetSql 

func (o *AllowlistEntry) GetSql() bool

GetSql returns the Sql field value.

func (*AllowlistEntry) GetUi 

func (o *AllowlistEntry) GetUi() bool

GetUi returns the Ui field value.

func (*AllowlistEntry) SetCidrIp 

func (o *AllowlistEntry) SetCidrIp(v string)

SetCidrIp sets field value.

func (*AllowlistEntry) SetCidrMask 

func (o *AllowlistEntry) SetCidrMask(v int32)

SetCidrMask sets field value.

func (*AllowlistEntry) SetName 

func (o *AllowlistEntry) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*AllowlistEntry) SetSql 

func (o *AllowlistEntry) SetSql(v bool)

SetSql sets field value.

func (*AllowlistEntry) SetUi 

func (o *AllowlistEntry) SetUi(v bool)

SetUi sets field value.

type AllowlistEntry1 added in v0.3.1 

type AllowlistEntry1 struct {
	Name *string `json:"name,omitempty"`
	Sql  bool    `json:"sql"`
	Ui   bool    `json:"ui"`
}

AllowlistEntry1 struct for AllowlistEntry1.

func NewAllowlistEntry1 added in v0.3.1 

func NewAllowlistEntry1(sql bool, ui bool) *AllowlistEntry1

NewAllowlistEntry1 instantiates a new AllowlistEntry1 object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAllowlistEntry1WithDefaults added in v0.3.1 

func NewAllowlistEntry1WithDefaults() *AllowlistEntry1

NewAllowlistEntry1WithDefaults instantiates a new AllowlistEntry1 object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AllowlistEntry1) GetName added in v0.3.1 

func (o *AllowlistEntry1) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*AllowlistEntry1) GetSql added in v0.3.1 

func (o *AllowlistEntry1) GetSql() bool

GetSql returns the Sql field value.

func (*AllowlistEntry1) GetUi added in v0.3.1 

func (o *AllowlistEntry1) GetUi() bool

GetUi returns the Ui field value.

func (*AllowlistEntry1) SetName added in v0.3.1 

func (o *AllowlistEntry1) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*AllowlistEntry1) SetSql added in v0.3.1 

func (o *AllowlistEntry1) SetSql(v bool)

SetSql sets field value.

func (*AllowlistEntry1) SetUi added in v0.3.1 

func (o *AllowlistEntry1) SetUi(v bool)

SetUi sets field value.

type Any 

type Any struct {
	// A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted).  In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:  * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][]   value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the   URL, or have them precompiled into a binary to avoid any   lookup. Therefore, binary compatibility needs to be preserved   on changes to types. (Use versioned type names to manage   breaking changes.)  Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.  Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
	Type *string `json:"@type,omitempty"`
}

Any `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": <string>, \"lastName\": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }.

func NewAny 

func NewAny() *Any

NewAny instantiates a new Any object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*Any) GetType 

func (o *Any) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*Any) SetType 

func (o *Any) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

type ApiKey added in v1.11.0 

type ApiKey struct {
	// the creation time of the api key.
	CreatedAt time.Time `json:"created_at"`
	// the ID of the api key.
	Id   string `json:"id"`
	Name string `json:"name"`
	// the ID of the service account the api key references.
	ServiceAccountId string `json:"service_account_id"`
}

ApiKey struct for ApiKey.

func NewApiKey added in v1.11.0 

func NewApiKey(createdAt time.Time, id string, name string, serviceAccountId string) *ApiKey

NewApiKey instantiates a new ApiKey object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewApiKeyWithDefaults added in v1.11.0 

func NewApiKeyWithDefaults() *ApiKey

NewApiKeyWithDefaults instantiates a new ApiKey object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ApiKey) GetCreatedAt added in v1.11.0 

func (o *ApiKey) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value.

func (*ApiKey) GetId added in v1.11.0 

func (o *ApiKey) GetId() string

GetId returns the Id field value.

func (*ApiKey) GetName added in v1.11.0 

func (o *ApiKey) GetName() string

GetName returns the Name field value.

func (*ApiKey) GetServiceAccountId added in v1.11.0 

func (o *ApiKey) GetServiceAccountId() string

GetServiceAccountId returns the ServiceAccountId field value.

func (*ApiKey) SetCreatedAt added in v1.11.0 

func (o *ApiKey) SetCreatedAt(v time.Time)

SetCreatedAt sets field value.

func (*ApiKey) SetId added in v1.11.0 

func (o *ApiKey) SetId(v string)

SetId sets field value.

func (*ApiKey) SetName added in v1.11.0 

func (o *ApiKey) SetName(v string)

SetName sets field value.

func (*ApiKey) SetServiceAccountId added in v1.11.0 

func (o *ApiKey) SetServiceAccountId(v string)

SetServiceAccountId sets field value.

type ApiOidcConfig added in v1.5.0 

type ApiOidcConfig struct {
	Audience    string                     `json:"audience"`
	Claim       *string                    `json:"claim,omitempty"`
	Id          string                     `json:"id"`
	IdentityMap *[]ApiOidcIdentityMapEntry `json:"identity_map,omitempty"`
	Issuer      string                     `json:"issuer"`
	Jwks        string                     `json:"jwks"`
}

ApiOidcConfig api_oidc_config contains information about an OIDC provider that can generate JWT tokens that can be used for authentication with the Cockroach Cloud API..

func NewApiOidcConfig added in v1.5.0 

func NewApiOidcConfig(audience string, id string, issuer string, jwks string) *ApiOidcConfig

NewApiOidcConfig instantiates a new ApiOidcConfig object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewApiOidcConfigWithDefaults added in v1.5.0 

func NewApiOidcConfigWithDefaults() *ApiOidcConfig

NewApiOidcConfigWithDefaults instantiates a new ApiOidcConfig object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ApiOidcConfig) GetAudience added in v1.5.0 

func (o *ApiOidcConfig) GetAudience() string

GetAudience returns the Audience field value.

func (*ApiOidcConfig) GetClaim added in v1.5.0 

func (o *ApiOidcConfig) GetClaim() string

GetClaim returns the Claim field value if set, zero value otherwise.

func (*ApiOidcConfig) GetId added in v1.5.0 

func (o *ApiOidcConfig) GetId() string

GetId returns the Id field value.

func (*ApiOidcConfig) GetIdentityMap added in v1.5.0 

func (o *ApiOidcConfig) GetIdentityMap() []ApiOidcIdentityMapEntry

GetIdentityMap returns the IdentityMap field value if set, zero value otherwise.

func (*ApiOidcConfig) GetIssuer added in v1.5.0 

func (o *ApiOidcConfig) GetIssuer() string

GetIssuer returns the Issuer field value.

func (*ApiOidcConfig) GetJwks added in v1.5.0 

func (o *ApiOidcConfig) GetJwks() string

GetJwks returns the Jwks field value.

func (*ApiOidcConfig) SetAudience added in v1.5.0 

func (o *ApiOidcConfig) SetAudience(v string)

SetAudience sets field value.

func (*ApiOidcConfig) SetClaim added in v1.5.0 

func (o *ApiOidcConfig) SetClaim(v string)

SetClaim gets a reference to the given string and assigns it to the Claim field.

func (*ApiOidcConfig) SetId added in v1.5.0 

func (o *ApiOidcConfig) SetId(v string)

SetId sets field value.

func (*ApiOidcConfig) SetIdentityMap added in v1.5.0 

func (o *ApiOidcConfig) SetIdentityMap(v []ApiOidcIdentityMapEntry)

SetIdentityMap gets a reference to the given []ApiOidcIdentityMapEntry and assigns it to the IdentityMap field.

func (*ApiOidcConfig) SetIssuer added in v1.5.0 

func (o *ApiOidcConfig) SetIssuer(v string)

SetIssuer sets field value.

func (*ApiOidcConfig) SetJwks added in v1.5.0 

func (o *ApiOidcConfig) SetJwks(v string)

SetJwks sets field value.

type ApiOidcConfig1 added in v1.5.0 

type ApiOidcConfig1 struct {
	Audience    string                     `json:"audience"`
	Claim       *string                    `json:"claim,omitempty"`
	IdentityMap *[]ApiOidcIdentityMapEntry `json:"identity_map,omitempty"`
	Issuer      string                     `json:"issuer"`
	Jwks        string                     `json:"jwks"`
}

ApiOidcConfig1 api_oidc_config contains information about an OIDC provider that can generate JWT tokens that can be used for authentication with the Cockroach Cloud API..

func NewApiOidcConfig1 added in v1.5.0 

func NewApiOidcConfig1(audience string, issuer string, jwks string) *ApiOidcConfig1

NewApiOidcConfig1 instantiates a new ApiOidcConfig1 object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewApiOidcConfig1WithDefaults added in v1.5.0 

func NewApiOidcConfig1WithDefaults() *ApiOidcConfig1

NewApiOidcConfig1WithDefaults instantiates a new ApiOidcConfig1 object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ApiOidcConfig1) GetAudience added in v1.5.0 

func (o *ApiOidcConfig1) GetAudience() string

GetAudience returns the Audience field value.

func (*ApiOidcConfig1) GetClaim added in v1.5.0 

func (o *ApiOidcConfig1) GetClaim() string

GetClaim returns the Claim field value if set, zero value otherwise.

func (*ApiOidcConfig1) GetIdentityMap added in v1.5.0 

func (o *ApiOidcConfig1) GetIdentityMap() []ApiOidcIdentityMapEntry

GetIdentityMap returns the IdentityMap field value if set, zero value otherwise.

func (*ApiOidcConfig1) GetIssuer added in v1.5.0 

func (o *ApiOidcConfig1) GetIssuer() string

GetIssuer returns the Issuer field value.

func (*ApiOidcConfig1) GetJwks added in v1.5.0 

func (o *ApiOidcConfig1) GetJwks() string

GetJwks returns the Jwks field value.

func (*ApiOidcConfig1) SetAudience added in v1.5.0 

func (o *ApiOidcConfig1) SetAudience(v string)

SetAudience sets field value.

func (*ApiOidcConfig1) SetClaim added in v1.5.0 

func (o *ApiOidcConfig1) SetClaim(v string)

SetClaim gets a reference to the given string and assigns it to the Claim field.

func (*ApiOidcConfig1) SetIdentityMap added in v1.5.0 

func (o *ApiOidcConfig1) SetIdentityMap(v []ApiOidcIdentityMapEntry)

SetIdentityMap gets a reference to the given []ApiOidcIdentityMapEntry and assigns it to the IdentityMap field.

func (*ApiOidcConfig1) SetIssuer added in v1.5.0 

func (o *ApiOidcConfig1) SetIssuer(v string)

SetIssuer sets field value.

func (*ApiOidcConfig1) SetJwks added in v1.5.0 

func (o *ApiOidcConfig1) SetJwks(v string)

SetJwks sets field value.

type ApiOidcIdentityMapEntry added in v1.7.0 

type ApiOidcIdentityMapEntry struct {
	CcIdentity    *string `json:"cc_identity,omitempty"`
	IsRegex       *bool   `json:"is_regex,omitempty"`
	TokenIdentity *string `json:"token_identity,omitempty"`
}

ApiOidcIdentityMapEntry struct for ApiOidcIdentityMapEntry.

func NewApiOidcIdentityMapEntry added in v1.7.0 

func NewApiOidcIdentityMapEntry() *ApiOidcIdentityMapEntry

NewApiOidcIdentityMapEntry instantiates a new ApiOidcIdentityMapEntry object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ApiOidcIdentityMapEntry) GetCcIdentity added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) GetCcIdentity() string

GetCcIdentity returns the CcIdentity field value if set, zero value otherwise.

func (*ApiOidcIdentityMapEntry) GetIsRegex added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) GetIsRegex() bool

GetIsRegex returns the IsRegex field value if set, zero value otherwise.

func (*ApiOidcIdentityMapEntry) GetTokenIdentity added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) GetTokenIdentity() string

GetTokenIdentity returns the TokenIdentity field value if set, zero value otherwise.

func (*ApiOidcIdentityMapEntry) SetCcIdentity added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) SetCcIdentity(v string)

SetCcIdentity gets a reference to the given string and assigns it to the CcIdentity field.

func (*ApiOidcIdentityMapEntry) SetIsRegex added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) SetIsRegex(v bool)

SetIsRegex gets a reference to the given bool and assigns it to the IsRegex field.

func (*ApiOidcIdentityMapEntry) SetTokenIdentity added in v1.7.0 

func (o *ApiOidcIdentityMapEntry) SetTokenIdentity(v string)

SetTokenIdentity gets a reference to the given string and assigns it to the TokenIdentity field.

type AuditLogAction added in v1.1.0 

type AuditLogAction string

AuditLogAction the model 'AuditLogAction'. 

const (
	AUDITLOGACTION_CREATE_CLUSTER                          AuditLogAction = "AUDIT_LOG_ACTION_CREATE_CLUSTER"
	AUDITLOGACTION_DELETE_CLUSTER                          AuditLogAction = "AUDIT_LOG_ACTION_DELETE_CLUSTER"
	AUDITLOGACTION_INVITE_USER_TO_ORGANIZATION             AuditLogAction = "AUDIT_LOG_ACTION_INVITE_USER_TO_ORGANIZATION"
	AUDITLOGACTION_EDIT_USER_INVITE                        AuditLogAction = "AUDIT_LOG_ACTION_EDIT_USER_INVITE"
	AUDITLOGACTION_REVOKE_USER_INVITE                      AuditLogAction = "AUDIT_LOG_ACTION_REVOKE_USER_INVITE"
	AUDITLOGACTION_ACCEPT_USER_INVITE                      AuditLogAction = "AUDIT_LOG_ACTION_ACCEPT_USER_INVITE"
	AUDITLOGACTION_ASSIGN_USER_ROLE                        AuditLogAction = "AUDIT_LOG_ACTION_ASSIGN_USER_ROLE"
	AUDITLOGACTION_DELETE_USER_FROM_ORGANIZATION           AuditLogAction = "AUDIT_LOG_ACTION_DELETE_USER_FROM_ORGANIZATION"
	AUDITLOGACTION_CREATE_SERVICE_ACCOUNT                  AuditLogAction = "AUDIT_LOG_ACTION_CREATE_SERVICE_ACCOUNT"
	AUDITLOGACTION_UPDATE_SERVICE_ACCOUNT                  AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_SERVICE_ACCOUNT"
	AUDITLOGACTION_DELETE_SERVICE_ACCOUNT                  AuditLogAction = "AUDIT_LOG_ACTION_DELETE_SERVICE_ACCOUNT"
	AUDITLOGACTION_CREATE_API_KEY                          AuditLogAction = "AUDIT_LOG_ACTION_CREATE_API_KEY"
	AUDITLOGACTION_UPDATE_API_KEY                          AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_API_KEY"
	AUDITLOGACTION_DELETE_API_KEY                          AuditLogAction = "AUDIT_LOG_ACTION_DELETE_API_KEY"
	AUDITLOGACTION_UPDATE_CLUSTER                          AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLUSTER"
	AUDITLOGACTION_CREATE_SQL_USER                         AuditLogAction = "AUDIT_LOG_ACTION_CREATE_SQL_USER"
	AUDITLOGACTION_CHANGE_SQL_USER_PASSWORD                AuditLogAction = "AUDIT_LOG_ACTION_CHANGE_SQL_USER_PASSWORD"
	AUDITLOGACTION_DELETE_SQL_USER                         AuditLogAction = "AUDIT_LOG_ACTION_DELETE_SQL_USER"
	AUDITLOGACTION_ADD_IP_ALLOWLIST                        AuditLogAction = "AUDIT_LOG_ACTION_ADD_IP_ALLOWLIST"
	AUDITLOGACTION_EDIT_IP_ALLOWLIST                       AuditLogAction = "AUDIT_LOG_ACTION_EDIT_IP_ALLOWLIST"
	AUDITLOGACTION_DELETE_IP_ALLOWLIST                     AuditLogAction = "AUDIT_LOG_ACTION_DELETE_IP_ALLOWLIST"
	AUDITLOGACTION_CREATE_VPC_PEERING                      AuditLogAction = "AUDIT_LOG_ACTION_CREATE_VPC_PEERING"
	AUDITLOGACTION_DELETE_VPC_PEERING                      AuditLogAction = "AUDIT_LOG_ACTION_DELETE_VPC_PEERING"
	AUDITLOGACTION_CREATE_PRIVATE_LINK                     AuditLogAction = "AUDIT_LOG_ACTION_CREATE_PRIVATE_LINK"
	AUDITLOGACTION_ACCEPT_PRIVATE_LINK                     AuditLogAction = "AUDIT_LOG_ACTION_ACCEPT_PRIVATE_LINK"
	AUDITLOGACTION_REJECT_PRIVATE_LINK                     AuditLogAction = "AUDIT_LOG_ACTION_REJECT_PRIVATE_LINK"
	AUDITLOGACTION_USER_LOGIN                              AuditLogAction = "AUDIT_LOG_ACTION_USER_LOGIN"
	AUDITLOGACTION_ADD_USER_TO_ROLE                        AuditLogAction = "AUDIT_LOG_ACTION_ADD_USER_TO_ROLE"
	AUDITLOGACTION_REMOVE_USER_FROM_ROLE                   AuditLogAction = "AUDIT_LOG_ACTION_REMOVE_USER_FROM_ROLE"
	AUDITLOGACTION_CREATE_USER                             AuditLogAction = "AUDIT_LOG_ACTION_CREATE_USER"
	AUDITLOGACTION_DELETE_USER                             AuditLogAction = "AUDIT_LOG_ACTION_DELETE_USER"
	AUDITLOGACTION_UPDATE_USER                             AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_USER"
	AUDITLOGACTION_CREATE_GROUP                            AuditLogAction = "AUDIT_LOG_ACTION_CREATE_GROUP"
	AUDITLOGACTION_DELETE_GROUP                            AuditLogAction = "AUDIT_LOG_ACTION_DELETE_GROUP"
	AUDITLOGACTION_UPDATE_GROUP                            AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_GROUP"
	AUDITLOGACTION_SET_CLIENT_CA_CERT                      AuditLogAction = "AUDIT_LOG_ACTION_SET_CLIENT_CA_CERT"
	AUDITLOGACTION_UPDATE_CLIENT_CA_CERT                   AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLIENT_CA_CERT"
	AUDITLOGACTION_DELETE_CLIENT_CA_CERT                   AuditLogAction = "AUDIT_LOG_ACTION_DELETE_CLIENT_CA_CERT"
	AUDITLOGACTION_CREATE_API_OIDC_CONFIG                  AuditLogAction = "AUDIT_LOG_ACTION_CREATE_API_OIDC_CONFIG"
	AUDITLOGACTION_DELETE_API_OIDC_CONFIG                  AuditLogAction = "AUDIT_LOG_ACTION_DELETE_API_OIDC_CONFIG"
	AUDITLOGACTION_UPDATE_API_OIDC_CONFIG                  AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_API_OIDC_CONFIG"
	AUDITLOGACTION_CREATE_FOLDER                           AuditLogAction = "AUDIT_LOG_ACTION_CREATE_FOLDER"
	AUDITLOGACTION_DELETE_FOLDER                           AuditLogAction = "AUDIT_LOG_ACTION_DELETE_FOLDER"
	AUDITLOGACTION_UPDATE_FOLDER                           AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_FOLDER"
	AUDITLOGACTION_ADD_PRIVATE_ENDPOINT_TRUSTED_OWNER      AuditLogAction = "AUDIT_LOG_ACTION_ADD_PRIVATE_ENDPOINT_TRUSTED_OWNER"
	AUDITLOGACTION_REMOVE_PRIVATE_ENDPOINT_TRUSTED_OWNER   AuditLogAction = "AUDIT_LOG_ACTION_REMOVE_PRIVATE_ENDPOINT_TRUSTED_OWNER"
	AUDITLOGACTION_ADD_ALERT_RECIPIENT                     AuditLogAction = "AUDIT_LOG_ACTION_ADD_ALERT_RECIPIENT"
	AUDITLOGACTION_REMOVE_ALERT_RECIPIENT                  AuditLogAction = "AUDIT_LOG_ACTION_REMOVE_ALERT_RECIPIENT"
	AUDITLOGACTION_TOGGLE_ALERTS                           AuditLogAction = "AUDIT_LOG_ACTION_TOGGLE_ALERTS"
	AUDITLOGACTION_TEST_ALERT_EMAIL                        AuditLogAction = "AUDIT_LOG_ACTION_TEST_ALERT_EMAIL"
	AUDITLOGACTION_UPDATE_CMEK                             AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CMEK"
	AUDITLOGACTION_REVOKE_CMEK                             AuditLogAction = "AUDIT_LOG_ACTION_REVOKE_CMEK"
	AUDITLOGACTION_UPDATE_CLUSTER_LOG_EXPORT               AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLUSTER_LOG_EXPORT"
	AUDITLOGACTION_DELETE_CLUSTER_LOG_EXPORT               AuditLogAction = "AUDIT_LOG_ACTION_DELETE_CLUSTER_LOG_EXPORT"
	AUDITLOGACTION_UPDATE_CLUSTER_METRIC_EXPORT            AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLUSTER_METRIC_EXPORT"
	AUDITLOGACTION_DELETE_CLUSTER_METRIC_EXPORT            AuditLogAction = "AUDIT_LOG_ACTION_DELETE_CLUSTER_METRIC_EXPORT"
	AUDITLOGACTION_RESTORE_CLUSTER                         AuditLogAction = "AUDIT_LOG_ACTION_RESTORE_CLUSTER"
	AUDITLOGACTION_UPDATE_CLUSTER_MAJOR_VERSION            AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLUSTER_MAJOR_VERSION"
	AUDITLOGACTION_ROLLBACK_CLUSTER_MAJOR_VERSION_UPDATE   AuditLogAction = "AUDIT_LOG_ACTION_ROLLBACK_CLUSTER_MAJOR_VERSION_UPDATE"
	AUDITLOGACTION_FINALIZE_CLUSTER_MAJOR_VERSION_UPDATE   AuditLogAction = "AUDIT_LOG_ACTION_FINALIZE_CLUSTER_MAJOR_VERSION_UPDATE"
	AUDITLOGACTION_UPDATE_CLUSTER_VERSION_UPGRADE_DEFERRAL AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_CLUSTER_VERSION_UPGRADE_DEFERRAL"
	AUDITLOGACTION_SET_CLUSTER_MAINTENANCE_WINDOW          AuditLogAction = "AUDIT_LOG_ACTION_SET_CLUSTER_MAINTENANCE_WINDOW"
	AUDITLOGACTION_DELETE_CLUSTER_MAINTENANCE_WINDOW       AuditLogAction = "AUDIT_LOG_ACTION_DELETE_CLUSTER_MAINTENANCE_WINDOW"
	AUDITLOGACTION_SET_EGRESS_TRAFFIC_POLICY               AuditLogAction = "AUDIT_LOG_ACTION_SET_EGRESS_TRAFFIC_POLICY"
	AUDITLOGACTION_ADD_EGRESS_RULE                         AuditLogAction = "AUDIT_LOG_ACTION_ADD_EGRESS_RULE"
	AUDITLOGACTION_EDIT_EGRESS_RULE                        AuditLogAction = "AUDIT_LOG_ACTION_EDIT_EGRESS_RULE"
	AUDITLOGACTION_DELETE_EGRESS_RULE                      AuditLogAction = "AUDIT_LOG_ACTION_DELETE_EGRESS_RULE"
	AUDITLOGACTION_ENABLE_CLOUD_ORG_SSO                    AuditLogAction = "AUDIT_LOG_ACTION_ENABLE_CLOUD_ORG_SSO"
	AUDITLOGACTION_ADD_AUTHENTICATION_METHOD               AuditLogAction = "AUDIT_LOG_ACTION_ADD_AUTHENTICATION_METHOD"
	AUDITLOGACTION_UPDATE_AUTHENTICATION_METHOD            AuditLogAction = "AUDIT_LOG_ACTION_UPDATE_AUTHENTICATION_METHOD"
	AUDITLOGACTION_DELETE_AUTHENTICATION_METHOD            AuditLogAction = "AUDIT_LOG_ACTION_DELETE_AUTHENTICATION_METHOD"
)

List of AuditLogAction.

func NewAuditLogActionFromValue added in v1.1.0 

func NewAuditLogActionFromValue(v string) (*AuditLogAction, error)

NewAuditLogActionFromValue returns a pointer to a valid AuditLogAction for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AuditLogAction) IsValid added in v1.1.0 

func (v AuditLogAction) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AuditLogAction) Ptr added in v1.1.0 

func (v AuditLogAction) Ptr() *AuditLogAction

Ptr returns reference to AuditLogAction value.

type AuditLogEntry added in v1.1.0 

type AuditLogEntry struct {
	Action *AuditLogAction `json:"action,omitempty"`
	// ClusterId is the ID of the cluster to which this log entry applies, if it applies to a single cluster.
	ClusterId *string `json:"cluster_id,omitempty"`
	// ClusterName is the name of the cluster to which this log entry applies, if it applies to a single cluster.
	ClusterName *string `json:"cluster_name,omitempty"`
	// CreatedAt is the time that this log entry was recorded.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Error is the error that applies to this entry if it represents a failure.
	Error *string `json:"error,omitempty"`
	// Id uniquely identifies this entry.
	Id       *string           `json:"id,omitempty"`
	Metadata *AuditLogMetadata `json:"metadata,omitempty"`
	// Payload is a representation of the essential details relating to this log entry.
	Payload *map[string]interface{} `json:"payload,omitempty"`
	// ServiceAccountName is the name of the service account that triggered this log entry. If it was not a service account, it will be empty.
	ServiceAccountName *string `json:"service_account_name,omitempty"`
	// SessionId is an ID that can be used to correlate this log entry with others that are emitted as part of the same user session, typically for users interacting through the UI. It should be treated as an opaque string with no guaranteed structure.
	SessionId *string         `json:"session_id,omitempty"`
	Source    *AuditLogSource `json:"source,omitempty"`
	// TraceId is an ID that can be used to correlate this log entry with others that are emitted as part of the same process. It should be treated as an opaque string with no guaranteed structure.
	TraceId *string `json:"trace_id,omitempty"`
	// UserEmail is the email address of the user that triggered this log entry. If it was not a human user, it will be empty.
	UserEmail *string `json:"user_email,omitempty"`
}

AuditLogEntry AuditLogEntry represents an entry in the cloud event log. Note that this message definition should always match exactly with the corresponding `AuditLogEntry` message in `console/consolepb/console.proto`..

func NewAuditLogEntry added in v1.1.0 

func NewAuditLogEntry() *AuditLogEntry

NewAuditLogEntry instantiates a new AuditLogEntry object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*AuditLogEntry) GetAction added in v1.1.0 

func (o *AuditLogEntry) GetAction() AuditLogAction

GetAction returns the Action field value if set, zero value otherwise.

func (*AuditLogEntry) GetClusterId added in v1.1.0 

func (o *AuditLogEntry) GetClusterId() string

GetClusterId returns the ClusterId field value if set, zero value otherwise.

func (*AuditLogEntry) GetClusterName added in v1.1.0 

func (o *AuditLogEntry) GetClusterName() string

GetClusterName returns the ClusterName field value if set, zero value otherwise.

func (*AuditLogEntry) GetCreatedAt added in v1.1.0 

func (o *AuditLogEntry) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*AuditLogEntry) GetError added in v1.1.0 

func (o *AuditLogEntry) GetError() string

GetError returns the Error field value if set, zero value otherwise.

func (*AuditLogEntry) GetId added in v1.1.0 

func (o *AuditLogEntry) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AuditLogEntry) GetMetadata added in v1.1.0 

func (o *AuditLogEntry) GetMetadata() AuditLogMetadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AuditLogEntry) GetPayload added in v1.1.0 

func (o *AuditLogEntry) GetPayload() map[string]interface{}

GetPayload returns the Payload field value if set, zero value otherwise.

func (*AuditLogEntry) GetServiceAccountName added in v1.1.0 

func (o *AuditLogEntry) GetServiceAccountName() string

GetServiceAccountName returns the ServiceAccountName field value if set, zero value otherwise.

func (*AuditLogEntry) GetSessionId added in v1.1.0 

func (o *AuditLogEntry) GetSessionId() string

GetSessionId returns the SessionId field value if set, zero value otherwise.

func (*AuditLogEntry) GetSource added in v1.1.0 

func (o *AuditLogEntry) GetSource() AuditLogSource

GetSource returns the Source field value if set, zero value otherwise.

func (*AuditLogEntry) GetTraceId added in v1.1.0 

func (o *AuditLogEntry) GetTraceId() string

GetTraceId returns the TraceId field value if set, zero value otherwise.

func (*AuditLogEntry) GetUserEmail added in v1.1.0 

func (o *AuditLogEntry) GetUserEmail() string

GetUserEmail returns the UserEmail field value if set, zero value otherwise.

func (*AuditLogEntry) SetAction added in v1.1.0 

func (o *AuditLogEntry) SetAction(v AuditLogAction)

SetAction gets a reference to the given AuditLogAction and assigns it to the Action field.

func (*AuditLogEntry) SetClusterId added in v1.1.0 

func (o *AuditLogEntry) SetClusterId(v string)

SetClusterId gets a reference to the given string and assigns it to the ClusterId field.

func (*AuditLogEntry) SetClusterName added in v1.1.0 

func (o *AuditLogEntry) SetClusterName(v string)

SetClusterName gets a reference to the given string and assigns it to the ClusterName field.

func (*AuditLogEntry) SetCreatedAt added in v1.1.0 

func (o *AuditLogEntry) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*AuditLogEntry) SetError added in v1.1.0 

func (o *AuditLogEntry) SetError(v string)

SetError gets a reference to the given string and assigns it to the Error field.

func (*AuditLogEntry) SetId added in v1.1.0 

func (o *AuditLogEntry) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AuditLogEntry) SetMetadata added in v1.1.0 

func (o *AuditLogEntry) SetMetadata(v AuditLogMetadata)

SetMetadata gets a reference to the given AuditLogMetadata and assigns it to the Metadata field.

func (*AuditLogEntry) SetPayload added in v1.1.0 

func (o *AuditLogEntry) SetPayload(v map[string]interface{})

SetPayload gets a reference to the given map[string]interface{} and assigns it to the Payload field.

func (*AuditLogEntry) SetServiceAccountName added in v1.1.0 

func (o *AuditLogEntry) SetServiceAccountName(v string)

SetServiceAccountName gets a reference to the given string and assigns it to the ServiceAccountName field.

func (*AuditLogEntry) SetSessionId added in v1.1.0 

func (o *AuditLogEntry) SetSessionId(v string)

SetSessionId gets a reference to the given string and assigns it to the SessionId field.

func (*AuditLogEntry) SetSource added in v1.1.0 

func (o *AuditLogEntry) SetSource(v AuditLogSource)

SetSource gets a reference to the given AuditLogSource and assigns it to the Source field.

func (*AuditLogEntry) SetTraceId added in v1.1.0 

func (o *AuditLogEntry) SetTraceId(v string)

SetTraceId gets a reference to the given string and assigns it to the TraceId field.

func (*AuditLogEntry) SetUserEmail added in v1.1.0 

func (o *AuditLogEntry) SetUserEmail(v string)

SetUserEmail gets a reference to the given string and assigns it to the UserEmail field.

type AuditLogMetadata added in v1.1.0 

type AuditLogMetadata struct {
	IpAddress *string `json:"ip_address,omitempty"`
}

AuditLogMetadata struct for AuditLogMetadata.

func NewAuditLogMetadata added in v1.1.0 

func NewAuditLogMetadata() *AuditLogMetadata

NewAuditLogMetadata instantiates a new AuditLogMetadata object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*AuditLogMetadata) GetIpAddress added in v1.1.0 

func (o *AuditLogMetadata) GetIpAddress() string

GetIpAddress returns the IpAddress field value if set, zero value otherwise.

func (*AuditLogMetadata) SetIpAddress added in v1.1.0 

func (o *AuditLogMetadata) SetIpAddress(v string)

SetIpAddress gets a reference to the given string and assigns it to the IpAddress field.

type AuditLogSource added in v1.1.0 

type AuditLogSource string

AuditLogSource the model 'AuditLogSource'. 

const (
	AUDITLOGSOURCE_CC_API   AuditLogSource = "AUDIT_LOG_SOURCE_CC_API"
	AUDITLOGSOURCE_CLI      AuditLogSource = "AUDIT_LOG_SOURCE_CLI"
	AUDITLOGSOURCE_UI       AuditLogSource = "AUDIT_LOG_SOURCE_UI"
	AUDITLOGSOURCE_INTERNAL AuditLogSource = "AUDIT_LOG_SOURCE_INTERNAL"
)

List of AuditLogSource.

func NewAuditLogSourceFromValue added in v1.1.0 

func NewAuditLogSourceFromValue(v string) (*AuditLogSource, error)

NewAuditLogSourceFromValue returns a pointer to a valid AuditLogSource for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AuditLogSource) IsValid added in v1.1.0 

func (v AuditLogSource) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AuditLogSource) Ptr added in v1.1.0 

func (v AuditLogSource) Ptr() *AuditLogSource

Ptr returns reference to AuditLogSource value.

type AwsEndpointConnection 

type AwsEndpointConnection struct {
	CloudProvider CloudProviderType `json:"cloud_provider"`
	// endpoint_id is the client side of the PrivateLink connection.
	EndpointId string `json:"endpoint_id"`
	// external_owner_id represents the ID of the AWS account that owns the PrivateLink connection.
	ExternalOwnerId *string `json:"external_owner_id,omitempty"`
	// region_name is the cloud provider region name (i.e. us-east-1).
	RegionName string `json:"region_name"`
	// service_id is the server side of the PrivateLink connection. This is the same as AWSPrivateLinkEndpoint.service_id.
	ServiceId string                          `json:"service_id"`
	Status    AWSEndpointConnectionStatusType `json:"status"`
}

AwsEndpointConnection struct for AwsEndpointConnection.

func NewAwsEndpointConnection 

func NewAwsEndpointConnection(cloudProvider CloudProviderType, endpointId string, regionName string, serviceId string, status AWSEndpointConnectionStatusType) *AwsEndpointConnection

NewAwsEndpointConnection instantiates a new AwsEndpointConnection object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAwsEndpointConnectionWithDefaults 

func NewAwsEndpointConnectionWithDefaults() *AwsEndpointConnection

NewAwsEndpointConnectionWithDefaults instantiates a new AwsEndpointConnection object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AwsEndpointConnection) GetCloudProvider 

func (o *AwsEndpointConnection) GetCloudProvider() CloudProviderType

GetCloudProvider returns the CloudProvider field value.

func (*AwsEndpointConnection) GetEndpointId 

func (o *AwsEndpointConnection) GetEndpointId() string

GetEndpointId returns the EndpointId field value.

func (*AwsEndpointConnection) GetExternalOwnerId added in v1.6.0 

func (o *AwsEndpointConnection) GetExternalOwnerId() string

GetExternalOwnerId returns the ExternalOwnerId field value if set, zero value otherwise.

func (*AwsEndpointConnection) GetRegionName 

func (o *AwsEndpointConnection) GetRegionName() string

GetRegionName returns the RegionName field value.

func (*AwsEndpointConnection) GetServiceId 

func (o *AwsEndpointConnection) GetServiceId() string

GetServiceId returns the ServiceId field value.

func (*AwsEndpointConnection) GetStatus 

func (o *AwsEndpointConnection) GetStatus() AWSEndpointConnectionStatusType

GetStatus returns the Status field value.

func (*AwsEndpointConnection) SetCloudProvider 

func (o *AwsEndpointConnection) SetCloudProvider(v CloudProviderType)

SetCloudProvider sets field value.

func (*AwsEndpointConnection) SetEndpointId 

func (o *AwsEndpointConnection) SetEndpointId(v string)

SetEndpointId sets field value.

func (*AwsEndpointConnection) SetExternalOwnerId added in v1.6.0 

func (o *AwsEndpointConnection) SetExternalOwnerId(v string)

SetExternalOwnerId gets a reference to the given string and assigns it to the ExternalOwnerId field.

func (*AwsEndpointConnection) SetRegionName 

func (o *AwsEndpointConnection) SetRegionName(v string)

SetRegionName sets field value.

func (*AwsEndpointConnection) SetServiceId 

func (o *AwsEndpointConnection) SetServiceId(v string)

SetServiceId sets field value.

func (*AwsEndpointConnection) SetStatus 

func (o *AwsEndpointConnection) SetStatus(v AWSEndpointConnectionStatusType)

SetStatus sets field value.

type AwsEndpointConnections 

type AwsEndpointConnections struct {
	// Connections is a list of private endpoints.
	Connections []AwsEndpointConnection `json:"connections"`
}

AwsEndpointConnections struct for AwsEndpointConnections.

func NewAwsEndpointConnections 

func NewAwsEndpointConnections(connections []AwsEndpointConnection) *AwsEndpointConnections

NewAwsEndpointConnections instantiates a new AwsEndpointConnections object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAwsEndpointConnectionsWithDefaults 

func NewAwsEndpointConnectionsWithDefaults() *AwsEndpointConnections

NewAwsEndpointConnectionsWithDefaults instantiates a new AwsEndpointConnections object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AwsEndpointConnections) GetConnections 

func (o *AwsEndpointConnections) GetConnections() []AwsEndpointConnection

GetConnections returns the Connections field value.

func (*AwsEndpointConnections) SetConnections 

func (o *AwsEndpointConnections) SetConnections(v []AwsEndpointConnection)

SetConnections sets field value.

type BuiltInFromGroups added in v1.1.0 

type BuiltInFromGroups struct {
	GroupNames *[]string    `json:"group_names,omitempty"`
	Role       *BuiltInRole `json:"role,omitempty"`
}

BuiltInFromGroups struct for BuiltInFromGroups.

func NewBuiltInFromGroups added in v1.1.0 

func NewBuiltInFromGroups() *BuiltInFromGroups

NewBuiltInFromGroups instantiates a new BuiltInFromGroups object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*BuiltInFromGroups) GetGroupNames added in v1.1.0 

func (o *BuiltInFromGroups) GetGroupNames() []string

GetGroupNames returns the GroupNames field value if set, zero value otherwise.

func (*BuiltInFromGroups) GetRole added in v1.1.0 

func (o *BuiltInFromGroups) GetRole() BuiltInRole

GetRole returns the Role field value if set, zero value otherwise.

func (*BuiltInFromGroups) SetGroupNames added in v1.1.0 

func (o *BuiltInFromGroups) SetGroupNames(v []string)

SetGroupNames gets a reference to the given []string and assigns it to the GroupNames field.

func (*BuiltInFromGroups) SetRole added in v1.1.0 

func (o *BuiltInFromGroups) SetRole(v BuiltInRole)

SetRole gets a reference to the given BuiltInRole and assigns it to the Role field.

type BuiltInRole added in v0.4.2 

type BuiltInRole struct {
	Name     OrganizationUserRoleType `json:"name"`
	Resource Resource                 `json:"resource"`
}

BuiltInRole struct for BuiltInRole.

func NewBuiltInRole added in v0.4.2 

func NewBuiltInRole(name OrganizationUserRoleType, resource Resource) *BuiltInRole

NewBuiltInRole instantiates a new BuiltInRole object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBuiltInRoleWithDefaults added in v0.4.4 

func NewBuiltInRoleWithDefaults() *BuiltInRole

NewBuiltInRoleWithDefaults instantiates a new BuiltInRole object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BuiltInRole) GetName added in v0.4.2 

func (o *BuiltInRole) GetName() OrganizationUserRoleType

GetName returns the Name field value.

func (*BuiltInRole) GetResource added in v0.4.2 

func (o *BuiltInRole) GetResource() Resource

GetResource returns the Resource field value.

func (*BuiltInRole) SetName added in v0.4.2 

func (o *BuiltInRole) SetName(v OrganizationUserRoleType)

SetName sets field value.

func (*BuiltInRole) SetResource added in v0.4.2 

func (o *BuiltInRole) SetResource(v Resource)

SetResource sets field value.

type CMEKClusterInfo 

type CMEKClusterInfo struct {
	RegionInfos *[]CMEKRegionInfo `json:"region_infos,omitempty"`
	Status      *CMEKStatus       `json:"status,omitempty"`
}

CMEKClusterInfo CMEKClusterInfo contains the status of CMEK across an entire cluster, including within each one its regions..

func NewCMEKClusterInfo 

func NewCMEKClusterInfo() *CMEKClusterInfo

NewCMEKClusterInfo instantiates a new CMEKClusterInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CMEKClusterInfo) GetRegionInfos 

func (o *CMEKClusterInfo) GetRegionInfos() []CMEKRegionInfo

GetRegionInfos returns the RegionInfos field value if set, zero value otherwise.

func (*CMEKClusterInfo) GetStatus 

func (o *CMEKClusterInfo) GetStatus() CMEKStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*CMEKClusterInfo) SetRegionInfos 

func (o *CMEKClusterInfo) SetRegionInfos(v []CMEKRegionInfo)

SetRegionInfos gets a reference to the given []CMEKRegionInfo and assigns it to the RegionInfos field.

func (*CMEKClusterInfo) SetStatus 

func (o *CMEKClusterInfo) SetStatus(v CMEKStatus)

SetStatus gets a reference to the given CMEKStatus and assigns it to the Status field.

type CMEKClusterSpecification 

type CMEKClusterSpecification struct {
	RegionSpecs []CMEKRegionSpecification `json:"region_specs"`
}

CMEKClusterSpecification struct for CMEKClusterSpecification.

func NewCMEKClusterSpecification 

func NewCMEKClusterSpecification(regionSpecs []CMEKRegionSpecification) *CMEKClusterSpecification

NewCMEKClusterSpecification instantiates a new CMEKClusterSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCMEKClusterSpecificationWithDefaults 

func NewCMEKClusterSpecificationWithDefaults() *CMEKClusterSpecification

NewCMEKClusterSpecificationWithDefaults instantiates a new CMEKClusterSpecification object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CMEKClusterSpecification) GetRegionSpecs 

func (o *CMEKClusterSpecification) GetRegionSpecs() []CMEKRegionSpecification

GetRegionSpecs returns the RegionSpecs field value.

func (*CMEKClusterSpecification) SetRegionSpecs 

func (o *CMEKClusterSpecification) SetRegionSpecs(v []CMEKRegionSpecification)

SetRegionSpecs sets field value.

type CMEKCustomerAction 

type CMEKCustomerAction string

CMEKCustomerAction CMEKCustomerAction enumerates the actions a customer can take on a cluster that has been enabled for CMEK. 

const (
	CMEKCUSTOMERACTION_REVOKE CMEKCustomerAction = "REVOKE"
)

List of CMEKCustomerAction.

func NewCMEKCustomerActionFromValue 

func NewCMEKCustomerActionFromValue(v string) (*CMEKCustomerAction, error)

NewCMEKCustomerActionFromValue returns a pointer to a valid CMEKCustomerAction for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (CMEKCustomerAction) IsValid 

func (v CMEKCustomerAction) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (CMEKCustomerAction) Ptr 

func (v CMEKCustomerAction) Ptr() *CMEKCustomerAction

Ptr returns reference to CMEKCustomerAction value.

type CMEKKeyInfo 

type CMEKKeyInfo struct {
	CreatedAt   *time.Time            `json:"created_at,omitempty"`
	Spec        *CMEKKeySpecification `json:"spec,omitempty"`
	Status      *CMEKStatus           `json:"status,omitempty"`
	UpdatedAt   *time.Time            `json:"updated_at,omitempty"`
	UserMessage *string               `json:"user_message,omitempty"`
}

CMEKKeyInfo CMEKKeyInfo contains the status of a customer-provided key alongside the specification..

func NewCMEKKeyInfo 

func NewCMEKKeyInfo() *CMEKKeyInfo

NewCMEKKeyInfo instantiates a new CMEKKeyInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CMEKKeyInfo) GetCreatedAt 

func (o *CMEKKeyInfo) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*CMEKKeyInfo) GetSpec 

func (o *CMEKKeyInfo) GetSpec() CMEKKeySpecification

GetSpec returns the Spec field value if set, zero value otherwise.

func (*CMEKKeyInfo) GetStatus 

func (o *CMEKKeyInfo) GetStatus() CMEKStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*CMEKKeyInfo) GetUpdatedAt 

func (o *CMEKKeyInfo) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*CMEKKeyInfo) GetUserMessage 

func (o *CMEKKeyInfo) GetUserMessage() string

GetUserMessage returns the UserMessage field value if set, zero value otherwise.

func (*CMEKKeyInfo) SetCreatedAt 

func (o *CMEKKeyInfo) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*CMEKKeyInfo) SetSpec 

func (o *CMEKKeyInfo) SetSpec(v CMEKKeySpecification)

SetSpec gets a reference to the given CMEKKeySpecification and assigns it to the Spec field.

func (*CMEKKeyInfo) SetStatus 

func (o *CMEKKeyInfo) SetStatus(v CMEKStatus)

SetStatus gets a reference to the given CMEKStatus and assigns it to the Status field.

func (*CMEKKeyInfo) SetUpdatedAt 

func (o *CMEKKeyInfo) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

func (*CMEKKeyInfo) SetUserMessage 

func (o *CMEKKeyInfo) SetUserMessage(v string)

SetUserMessage gets a reference to the given string and assigns it to the UserMessage field.

type CMEKKeySpecification 

type CMEKKeySpecification struct {
	AuthPrincipal *string      `json:"auth_principal,omitempty"`
	Type          *CMEKKeyType `json:"type,omitempty"`
	Uri           *string      `json:"uri,omitempty"`
}

CMEKKeySpecification CMEKKeySpecification contains all the details necessary to use a customer-provided encryption key. This involves the type/location of the key and the principal to authenticate as when accessing it..

func NewCMEKKeySpecification 

func NewCMEKKeySpecification() *CMEKKeySpecification

NewCMEKKeySpecification instantiates a new CMEKKeySpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CMEKKeySpecification) GetAuthPrincipal 

func (o *CMEKKeySpecification) GetAuthPrincipal() string

GetAuthPrincipal returns the AuthPrincipal field value if set, zero value otherwise.

func (*CMEKKeySpecification) GetType 

func (o *CMEKKeySpecification) GetType() CMEKKeyType

GetType returns the Type field value if set, zero value otherwise.

func (*CMEKKeySpecification) GetUri 

func (o *CMEKKeySpecification) GetUri() string

GetUri returns the Uri field value if set, zero value otherwise.

func (*CMEKKeySpecification) SetAuthPrincipal 

func (o *CMEKKeySpecification) SetAuthPrincipal(v string)

SetAuthPrincipal gets a reference to the given string and assigns it to the AuthPrincipal field.

func (*CMEKKeySpecification) SetType 

func (o *CMEKKeySpecification) SetType(v CMEKKeyType)

SetType gets a reference to the given CMEKKeyType and assigns it to the Type field.

func (*CMEKKeySpecification) SetUri 

func (o *CMEKKeySpecification) SetUri(v string)

SetUri gets a reference to the given string and assigns it to the Uri field.

type CMEKKeyType 

type CMEKKeyType string

CMEKKeyType the model 'CMEKKeyType'. 

const (
	CMEKKEYTYPE_AWS_KMS       CMEKKeyType = "AWS_KMS"
	CMEKKEYTYPE_GCP_CLOUD_KMS CMEKKeyType = "GCP_CLOUD_KMS"
	CMEKKEYTYPE_NULL_KMS      CMEKKeyType = "NULL_KMS"
)

List of CMEKKeyType.

func NewCMEKKeyTypeFromValue 

func NewCMEKKeyTypeFromValue(v string) (*CMEKKeyType, error)

NewCMEKKeyTypeFromValue returns a pointer to a valid CMEKKeyType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (CMEKKeyType) IsValid 

func (v CMEKKeyType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (CMEKKeyType) Ptr 

func (v CMEKKeyType) Ptr() *CMEKKeyType

Ptr returns reference to CMEKKeyType value.

type CMEKRegionInfo 

type CMEKRegionInfo struct {
	KeyInfos *[]CMEKKeyInfo `json:"key_infos,omitempty"`
	Region   *string        `json:"region,omitempty"`
	Status   *CMEKStatus    `json:"status,omitempty"`
}

CMEKRegionInfo CMEKRegionInfo contains the status of CMEK within a region. This includes current and past key specifications used within the region, as well as the status of those specifications.

func NewCMEKRegionInfo 

func NewCMEKRegionInfo() *CMEKRegionInfo

NewCMEKRegionInfo instantiates a new CMEKRegionInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CMEKRegionInfo) GetKeyInfos 

func (o *CMEKRegionInfo) GetKeyInfos() []CMEKKeyInfo

GetKeyInfos returns the KeyInfos field value if set, zero value otherwise.

func (*CMEKRegionInfo) GetRegion 

func (o *CMEKRegionInfo) GetRegion() string

GetRegion returns the Region field value if set, zero value otherwise.

func (*CMEKRegionInfo) GetStatus 

func (o *CMEKRegionInfo) GetStatus() CMEKStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*CMEKRegionInfo) SetKeyInfos 

func (o *CMEKRegionInfo) SetKeyInfos(v []CMEKKeyInfo)

SetKeyInfos gets a reference to the given []CMEKKeyInfo and assigns it to the KeyInfos field.

func (*CMEKRegionInfo) SetRegion 

func (o *CMEKRegionInfo) SetRegion(v string)

SetRegion gets a reference to the given string and assigns it to the Region field.

func (*CMEKRegionInfo) SetStatus 

func (o *CMEKRegionInfo) SetStatus(v CMEKStatus)

SetStatus gets a reference to the given CMEKStatus and assigns it to the Status field.

type CMEKRegionSpecification 

type CMEKRegionSpecification struct {
	KeySpec *CMEKKeySpecification `json:"key_spec,omitempty"`
	Region  *string               `json:"region,omitempty"`
}

CMEKRegionSpecification CMEKRegionSpecification declares the customer-provided key specification that should be used in a given region..

func NewCMEKRegionSpecification 

func NewCMEKRegionSpecification() *CMEKRegionSpecification

NewCMEKRegionSpecification instantiates a new CMEKRegionSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CMEKRegionSpecification) GetKeySpec 

func (o *CMEKRegionSpecification) GetKeySpec() CMEKKeySpecification

GetKeySpec returns the KeySpec field value if set, zero value otherwise.

func (*CMEKRegionSpecification) GetRegion 

func (o *CMEKRegionSpecification) GetRegion() string

GetRegion returns the Region field value if set, zero value otherwise.

func (*CMEKRegionSpecification) SetKeySpec 

func (o *CMEKRegionSpecification) SetKeySpec(v CMEKKeySpecification)

SetKeySpec gets a reference to the given CMEKKeySpecification and assigns it to the KeySpec field.

func (*CMEKRegionSpecification) SetRegion 

func (o *CMEKRegionSpecification) SetRegion(v string)

SetRegion gets a reference to the given string and assigns it to the Region field.

type CMEKStatus 

type CMEKStatus string

CMEKStatus CMEKStatus describes the current status of CMEK for an entire CRDB cluster or a CMEK key within a region. - DISABLED: DISABLED corresponds to the state of a cluster or region-level key when CMEK has finished being disabled. By default, CMEK will be disabled for new clusters. - DISABLING: DISABLING corresponds to the state of a cluster or region-level key when CMEK is in the process of being disabled. - DISABLE_FAILED: DISABLE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be disabled. - ENABLED: ENABLED corresponds to the state of a cluster or region-level key when CMEK is enabled. - ENABLING: ENABLING corresponds to the state of a cluster or region-level key when CMEK is in the process of being enabled. - ENABLE_FAILED: ENABLE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be enabled. - ROTATING: ROTATING corresponds to the state of a cluster or region when the a new spec is in the process of being enabled while an existing spec is being disabled. - ROTATE_FAILED: ROTATE_FAILED corresponds to the state of a cluster or region if there was a failure to update from one CMEK spec to another. - REVOKED: REVOKED corresponds to the state of a cluster or region-level key when the customer has revoked CockroachLab's permissions for their key. - REVOKING: REVOKING corresponds to the state of a cluster or region-level key when CMEK is in the process of being revoked. - REVOKE_FAILED: REVOKE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be revoked. 

const (
	CMEKSTATUS_DISABLED       CMEKStatus = "DISABLED"
	CMEKSTATUS_DISABLING      CMEKStatus = "DISABLING"
	CMEKSTATUS_DISABLE_FAILED CMEKStatus = "DISABLE_FAILED"
	CMEKSTATUS_ENABLED        CMEKStatus = "ENABLED"
	CMEKSTATUS_ENABLING       CMEKStatus = "ENABLING"
	CMEKSTATUS_ENABLE_FAILED  CMEKStatus = "ENABLE_FAILED"
	CMEKSTATUS_ROTATING       CMEKStatus = "ROTATING"
	CMEKSTATUS_ROTATE_FAILED  CMEKStatus = "ROTATE_FAILED"
	CMEKSTATUS_REVOKED        CMEKStatus = "REVOKED"
	CMEKSTATUS_REVOKING       CMEKStatus = "REVOKING"
	CMEKSTATUS_REVOKE_FAILED  CMEKStatus = "REVOKE_FAILED"
)

List of CMEKStatus.

func NewCMEKStatusFromValue 

func NewCMEKStatusFromValue(v string) (*CMEKStatus, error)

NewCMEKStatusFromValue returns a pointer to a valid CMEKStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (CMEKStatus) IsValid 

func (v CMEKStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (CMEKStatus) Ptr 

func (v CMEKStatus) Ptr() *CMEKStatus

Ptr returns reference to CMEKStatus value.

type Client 

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

Client manages communication with the CockroachDB Cloud API v2023-04-10.

func NewClient 

func NewClient(cfg *Configuration) *Client

NewClient creates a new API client. Requires a userAgent string describing your application. Optionally a custom http.Client to allow for advanced features such as caching.

func (*Client) GetConfig 

func (c *Client) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing. Caution: modifying the configuration while live can cause data races and potentially unwanted behavior.

type ClientCACertInfo added in v0.4.2 

type ClientCACertInfo struct {
	Status      *ClientCACertStatus `json:"status,omitempty"`
	X509PemCert *string             `json:"x509_pem_cert,omitempty"`
}

ClientCACertInfo struct for ClientCACertInfo.

func NewClientCACertInfo added in v0.4.2 

func NewClientCACertInfo() *ClientCACertInfo

NewClientCACertInfo instantiates a new ClientCACertInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ClientCACertInfo) GetStatus added in v0.4.2 

func (o *ClientCACertInfo) GetStatus() ClientCACertStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*ClientCACertInfo) GetX509PemCert added in v0.4.2 

func (o *ClientCACertInfo) GetX509PemCert() string

GetX509PemCert returns the X509PemCert field value if set, zero value otherwise.

func (*ClientCACertInfo) SetStatus added in v0.4.2 

func (o *ClientCACertInfo) SetStatus(v ClientCACertStatus)

SetStatus gets a reference to the given ClientCACertStatus and assigns it to the Status field.

func (*ClientCACertInfo) SetX509PemCert added in v0.4.2 

func (o *ClientCACertInfo) SetX509PemCert(v string)

SetX509PemCert gets a reference to the given string and assigns it to the X509PemCert field.

type ClientCACertStatus added in v0.4.2 

type ClientCACertStatus string

ClientCACertStatus - NOT_SET: NOT_SET indicates a client CA cert is not set on the cluster. New clusters won't have a client CA cert set. - IS_SET: IS_SET indicates a client CA cert is set on the cluster. - PENDING: PENDING indicates a client CA cert update is in flight on the cluster. - FAILED: FAILED indicates a client CA cert update was attempted, but failed. 

const (
	CLIENTCACERTSTATUS_NOT_SET ClientCACertStatus = "NOT_SET"
	CLIENTCACERTSTATUS_IS_SET  ClientCACertStatus = "IS_SET"
	CLIENTCACERTSTATUS_PENDING ClientCACertStatus = "PENDING"
	CLIENTCACERTSTATUS_FAILED  ClientCACertStatus = "FAILED"
)

List of ClientCACertStatus.

func NewClientCACertStatusFromValue added in v0.4.2 

func NewClientCACertStatusFromValue(v string) (*ClientCACertStatus, error)

NewClientCACertStatusFromValue returns a pointer to a valid ClientCACertStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClientCACertStatus) IsValid added in v0.4.2 

func (v ClientCACertStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClientCACertStatus) Ptr added in v0.4.2 

func (v ClientCACertStatus) Ptr() *ClientCACertStatus

Ptr returns reference to ClientCACertStatus value.

type CloudProviderRegion 

type CloudProviderRegion struct {
	// Distance in miles, based on client IP address.
	Distance   float32           `json:"distance"`
	Location   string            `json:"location"`
	Name       string            `json:"name"`
	Provider   CloudProviderType `json:"provider"`
	Serverless bool              `json:"serverless"`
}

CloudProviderRegion struct for CloudProviderRegion.

func NewCloudProviderRegion 

func NewCloudProviderRegion(distance float32, location string, name string, provider CloudProviderType, serverless bool) *CloudProviderRegion

NewCloudProviderRegion instantiates a new CloudProviderRegion object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCloudProviderRegionWithDefaults 

func NewCloudProviderRegionWithDefaults() *CloudProviderRegion

NewCloudProviderRegionWithDefaults instantiates a new CloudProviderRegion object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CloudProviderRegion) GetDistance 

func (o *CloudProviderRegion) GetDistance() float32

GetDistance returns the Distance field value.

func (*CloudProviderRegion) GetLocation 

func (o *CloudProviderRegion) GetLocation() string

GetLocation returns the Location field value.

func (*CloudProviderRegion) GetName 

func (o *CloudProviderRegion) GetName() string

GetName returns the Name field value.

func (*CloudProviderRegion) GetProvider 

func (o *CloudProviderRegion) GetProvider() CloudProviderType

GetProvider returns the Provider field value.

func (*CloudProviderRegion) GetServerless 

func (o *CloudProviderRegion) GetServerless() bool

GetServerless returns the Serverless field value.

func (*CloudProviderRegion) SetDistance 

func (o *CloudProviderRegion) SetDistance(v float32)

SetDistance sets field value.

func (*CloudProviderRegion) SetLocation 

func (o *CloudProviderRegion) SetLocation(v string)

SetLocation sets field value.

func (*CloudProviderRegion) SetName 

func (o *CloudProviderRegion) SetName(v string)

SetName sets field value.

func (*CloudProviderRegion) SetProvider 

func (o *CloudProviderRegion) SetProvider(v CloudProviderType)

SetProvider sets field value.

func (*CloudProviderRegion) SetServerless 

func (o *CloudProviderRegion) SetServerless(v bool)

SetServerless sets field value.

type CloudProviderType added in v1.0.0 

type CloudProviderType string

CloudProviderType - GCP: The Google Cloud Platform cloud provider. - AWS: The Amazon Web Services cloud provider. - AZURE: The Azure cloud provider. 

const (
	CLOUDPROVIDERTYPE_GCP   CloudProviderType = "GCP"
	CLOUDPROVIDERTYPE_AWS   CloudProviderType = "AWS"
	CLOUDPROVIDERTYPE_AZURE CloudProviderType = "AZURE"
)

List of CloudProvider.Type.

func NewCloudProviderTypeFromValue added in v1.0.0 

func NewCloudProviderTypeFromValue(v string) (*CloudProviderType, error)

NewCloudProviderTypeFromValue returns a pointer to a valid CloudProviderType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (CloudProviderType) IsValid added in v1.0.0 

func (v CloudProviderType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (CloudProviderType) Ptr added in v1.0.0 

func (v CloudProviderType) Ptr() *CloudProviderType

Ptr returns reference to CloudProvider.Type value.

type CloudWatchMetricExportInfo added in v0.4.3 

type CloudWatchMetricExportInfo struct {
	ClusterId string `json:"cluster_id"`
	// log_group_name is the customized log group name.
	LogGroupName *string `json:"log_group_name,omitempty"`
	// role_arn is the IAM role used to upload metric segments to the target AWS account.
	RoleArn string                  `json:"role_arn"`
	Status  *MetricExportStatusType `json:"status,omitempty"`
	// target_region specifies the specific AWS region that the metrics will be exported to.
	TargetRegion *string `json:"target_region,omitempty"`
	UserMessage  *string `json:"user_message,omitempty"`
}

CloudWatchMetricExportInfo struct for CloudWatchMetricExportInfo.

func NewCloudWatchMetricExportInfo added in v0.4.3 

func NewCloudWatchMetricExportInfo(clusterId string, roleArn string) *CloudWatchMetricExportInfo

NewCloudWatchMetricExportInfo instantiates a new CloudWatchMetricExportInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCloudWatchMetricExportInfoWithDefaults added in v0.4.3 

func NewCloudWatchMetricExportInfoWithDefaults() *CloudWatchMetricExportInfo

NewCloudWatchMetricExportInfoWithDefaults instantiates a new CloudWatchMetricExportInfo object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CloudWatchMetricExportInfo) GetClusterId added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*CloudWatchMetricExportInfo) GetLogGroupName added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetLogGroupName() string

GetLogGroupName returns the LogGroupName field value if set, zero value otherwise.

func (*CloudWatchMetricExportInfo) GetRoleArn added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetRoleArn() string

GetRoleArn returns the RoleArn field value.

func (*CloudWatchMetricExportInfo) GetStatus added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetStatus() MetricExportStatusType

GetStatus returns the Status field value if set, zero value otherwise.

func (*CloudWatchMetricExportInfo) GetTargetRegion added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetTargetRegion() string

GetTargetRegion returns the TargetRegion field value if set, zero value otherwise.

func (*CloudWatchMetricExportInfo) GetUserMessage added in v0.4.3 

func (o *CloudWatchMetricExportInfo) GetUserMessage() string

GetUserMessage returns the UserMessage field value if set, zero value otherwise.

func (*CloudWatchMetricExportInfo) SetClusterId added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetClusterId(v string)

SetClusterId sets field value.

func (*CloudWatchMetricExportInfo) SetLogGroupName added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetLogGroupName(v string)

SetLogGroupName gets a reference to the given string and assigns it to the LogGroupName field.

func (*CloudWatchMetricExportInfo) SetRoleArn added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetRoleArn(v string)

SetRoleArn sets field value.

func (*CloudWatchMetricExportInfo) SetStatus added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetStatus(v MetricExportStatusType)

SetStatus gets a reference to the given MetricExportStatusType and assigns it to the Status field.

func (*CloudWatchMetricExportInfo) SetTargetRegion added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetTargetRegion(v string)

SetTargetRegion gets a reference to the given string and assigns it to the TargetRegion field.

func (*CloudWatchMetricExportInfo) SetUserMessage added in v0.4.3 

func (o *CloudWatchMetricExportInfo) SetUserMessage(v string)

SetUserMessage gets a reference to the given string and assigns it to the UserMessage field.

type Cluster 

type Cluster struct {
	AccountId           *string                    `json:"account_id,omitempty"`
	CloudProvider       CloudProviderType          `json:"cloud_provider"`
	CockroachVersion    string                     `json:"cockroach_version"`
	Config              ClusterConfig              `json:"config"`
	CreatedAt           *time.Time                 `json:"created_at,omitempty"`
	CreatorId           string                     `json:"creator_id"`
	DeleteProtection    *DeleteProtectionStateType `json:"delete_protection,omitempty"`
	DeletedAt           *time.Time                 `json:"deleted_at,omitempty"`
	EgressTrafficPolicy *EgressTrafficPolicyType   `json:"egress_traffic_policy,omitempty"`
	Id                  string                     `json:"id"`
	Name                string                     `json:"name"`
	NetworkVisibility   *NetworkVisibilityType     `json:"network_visibility,omitempty"`
	OperationStatus     ClusterStatusType          `json:"operation_status"`
	// Limited Access: The parent ID is a folder ID. A \"root\" valued parent ID refers to a cluster at the root level.
	ParentId *string  `json:"parent_id,omitempty"`
	Plan     PlanType `json:"plan"`
	Regions  []Region `json:"regions"`
	// sql_dns is the DNS name of SQL interface of the cluster.
	SqlDns        *string                  `json:"sql_dns,omitempty"`
	State         ClusterStateType         `json:"state"`
	UpdatedAt     *time.Time               `json:"updated_at,omitempty"`
	UpgradeStatus ClusterUpgradeStatusType `json:"upgrade_status"`
}

Cluster struct for Cluster.

func NewCluster 

func NewCluster(cloudProvider CloudProviderType, cockroachVersion string, config ClusterConfig, creatorId string, id string, name string, operationStatus ClusterStatusType, plan PlanType, regions []Region, state ClusterStateType, upgradeStatus ClusterUpgradeStatusType) *Cluster

NewCluster instantiates a new Cluster object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewClusterWithDefaults 

func NewClusterWithDefaults() *Cluster

NewClusterWithDefaults instantiates a new Cluster object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Cluster) GetAccountId 

func (o *Cluster) GetAccountId() string

GetAccountId returns the AccountId field value if set, zero value otherwise.

func (*Cluster) GetCloudProvider 

func (o *Cluster) GetCloudProvider() CloudProviderType

GetCloudProvider returns the CloudProvider field value.

func (*Cluster) GetCockroachVersion 

func (o *Cluster) GetCockroachVersion() string

GetCockroachVersion returns the CockroachVersion field value.

func (*Cluster) GetConfig 

func (o *Cluster) GetConfig() ClusterConfig

GetConfig returns the Config field value.

func (*Cluster) GetCreatedAt 

func (o *Cluster) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*Cluster) GetCreatorId 

func (o *Cluster) GetCreatorId() string

GetCreatorId returns the CreatorId field value.

func (*Cluster) GetDeleteProtection added in v1.10.0 

func (o *Cluster) GetDeleteProtection() DeleteProtectionStateType

GetDeleteProtection returns the DeleteProtection field value if set, zero value otherwise.

func (*Cluster) GetDeletedAt 

func (o *Cluster) GetDeletedAt() time.Time

GetDeletedAt returns the DeletedAt field value if set, zero value otherwise.

func (*Cluster) GetEgressTrafficPolicy added in v0.3.4 

func (o *Cluster) GetEgressTrafficPolicy() EgressTrafficPolicyType

GetEgressTrafficPolicy returns the EgressTrafficPolicy field value if set, zero value otherwise.

func (*Cluster) GetId 

func (o *Cluster) GetId() string

GetId returns the Id field value.

func (*Cluster) GetName 

func (o *Cluster) GetName() string

GetName returns the Name field value.

func (*Cluster) GetNetworkVisibility added in v0.3.3 

func (o *Cluster) GetNetworkVisibility() NetworkVisibilityType

GetNetworkVisibility returns the NetworkVisibility field value if set, zero value otherwise.

func (*Cluster) GetOperationStatus 

func (o *Cluster) GetOperationStatus() ClusterStatusType

GetOperationStatus returns the OperationStatus field value.

func (*Cluster) GetParentId added in v1.4.0 

func (o *Cluster) GetParentId() string

GetParentId returns the ParentId field value if set, zero value otherwise.

func (*Cluster) GetPlan 

func (o *Cluster) GetPlan() PlanType

GetPlan returns the Plan field value.

func (*Cluster) GetRegions 

func (o *Cluster) GetRegions() []Region

GetRegions returns the Regions field value.

func (*Cluster) GetSqlDns added in v0.3.3 

func (o *Cluster) GetSqlDns() string

GetSqlDns returns the SqlDns field value if set, zero value otherwise.

func (*Cluster) GetState 

func (o *Cluster) GetState() ClusterStateType

GetState returns the State field value.

func (*Cluster) GetUpdatedAt 

func (o *Cluster) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*Cluster) GetUpgradeStatus added in v0.4.0 

func (o *Cluster) GetUpgradeStatus() ClusterUpgradeStatusType

GetUpgradeStatus returns the UpgradeStatus field value.

func (*Cluster) SetAccountId 

func (o *Cluster) SetAccountId(v string)

SetAccountId gets a reference to the given string and assigns it to the AccountId field.

func (*Cluster) SetCloudProvider 

func (o *Cluster) SetCloudProvider(v CloudProviderType)

SetCloudProvider sets field value.

func (*Cluster) SetCockroachVersion 

func (o *Cluster) SetCockroachVersion(v string)

SetCockroachVersion sets field value.

func (*Cluster) SetConfig 

func (o *Cluster) SetConfig(v ClusterConfig)

SetConfig sets field value.

func (*Cluster) SetCreatedAt 

func (o *Cluster) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*Cluster) SetCreatorId 

func (o *Cluster) SetCreatorId(v string)

SetCreatorId sets field value.

func (*Cluster) SetDeleteProtection added in v1.10.0 

func (o *Cluster) SetDeleteProtection(v DeleteProtectionStateType)

SetDeleteProtection gets a reference to the given DeleteProtectionStateType and assigns it to the DeleteProtection field.

func (*Cluster) SetDeletedAt 

func (o *Cluster) SetDeletedAt(v time.Time)

SetDeletedAt gets a reference to the given time.Time and assigns it to the DeletedAt field.

func (*Cluster) SetEgressTrafficPolicy added in v0.3.4 

func (o *Cluster) SetEgressTrafficPolicy(v EgressTrafficPolicyType)

SetEgressTrafficPolicy gets a reference to the given EgressTrafficPolicyType and assigns it to the EgressTrafficPolicy field.

func (*Cluster) SetId 

func (o *Cluster) SetId(v string)

SetId sets field value.

func (*Cluster) SetName 

func (o *Cluster) SetName(v string)

SetName sets field value.

func (*Cluster) SetNetworkVisibility added in v0.3.3 

func (o *Cluster) SetNetworkVisibility(v NetworkVisibilityType)

SetNetworkVisibility gets a reference to the given NetworkVisibilityType and assigns it to the NetworkVisibility field.

func (*Cluster) SetOperationStatus 

func (o *Cluster) SetOperationStatus(v ClusterStatusType)

SetOperationStatus sets field value.

func (*Cluster) SetParentId added in v1.4.0 

func (o *Cluster) SetParentId(v string)

SetParentId gets a reference to the given string and assigns it to the ParentId field.

func (*Cluster) SetPlan 

func (o *Cluster) SetPlan(v PlanType)

SetPlan sets field value.

func (*Cluster) SetRegions 

func (o *Cluster) SetRegions(v []Region)

SetRegions sets field value.

func (*Cluster) SetSqlDns added in v0.3.3 

func (o *Cluster) SetSqlDns(v string)

SetSqlDns gets a reference to the given string and assigns it to the SqlDns field.

func (*Cluster) SetState 

func (o *Cluster) SetState(v ClusterStateType)

SetState sets field value.

func (*Cluster) SetUpdatedAt 

func (o *Cluster) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

func (*Cluster) SetUpgradeStatus added in v0.4.0 

func (o *Cluster) SetUpgradeStatus(v ClusterUpgradeStatusType)

SetUpgradeStatus sets field value.

type ClusterConfig 

type ClusterConfig struct {
	Dedicated  *DedicatedHardwareConfig `json:"dedicated,omitempty"`
	Serverless *ServerlessClusterConfig `json:"serverless,omitempty"`
}

ClusterConfig struct for ClusterConfig.

func NewClusterConfig 

func NewClusterConfig() *ClusterConfig

NewClusterConfig instantiates a new ClusterConfig object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ClusterConfig) GetDedicated 

func (o *ClusterConfig) GetDedicated() DedicatedHardwareConfig

GetDedicated returns the Dedicated field value if set, zero value otherwise.

func (*ClusterConfig) GetServerless 

func (o *ClusterConfig) GetServerless() ServerlessClusterConfig

GetServerless returns the Serverless field value if set, zero value otherwise.

func (*ClusterConfig) SetDedicated 

func (o *ClusterConfig) SetDedicated(v DedicatedHardwareConfig)

SetDedicated gets a reference to the given DedicatedHardwareConfig and assigns it to the Dedicated field.

func (*ClusterConfig) SetServerless 

func (o *ClusterConfig) SetServerless(v ServerlessClusterConfig)

SetServerless gets a reference to the given ServerlessClusterConfig and assigns it to the Serverless field.

type ClusterMajorVersion added in v0.4.1 

type ClusterMajorVersion struct {
	SupportStatus ClusterMajorVersionSupportStatusType `json:"support_status"`
	Version       string                               `json:"version"`
}

ClusterMajorVersion For more information about CockroachDB cluster version support, see https://www.cockroachlabs.com/docs/releases/release-support-policy.html.

func NewClusterMajorVersion added in v0.4.1 

func NewClusterMajorVersion(supportStatus ClusterMajorVersionSupportStatusType, version string) *ClusterMajorVersion

NewClusterMajorVersion instantiates a new ClusterMajorVersion object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewClusterMajorVersionWithDefaults added in v0.4.1 

func NewClusterMajorVersionWithDefaults() *ClusterMajorVersion

NewClusterMajorVersionWithDefaults instantiates a new ClusterMajorVersion object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ClusterMajorVersion) GetSupportStatus added in v0.4.1 

func (o *ClusterMajorVersion) GetSupportStatus() ClusterMajorVersionSupportStatusType

GetSupportStatus returns the SupportStatus field value.

func (*ClusterMajorVersion) GetVersion added in v0.4.1 

func (o *ClusterMajorVersion) GetVersion() string

GetVersion returns the Version field value.

func (*ClusterMajorVersion) SetSupportStatus added in v0.4.1 

func (o *ClusterMajorVersion) SetSupportStatus(v ClusterMajorVersionSupportStatusType)

SetSupportStatus sets field value.

func (*ClusterMajorVersion) SetVersion added in v0.4.1 

func (o *ClusterMajorVersion) SetVersion(v string)

SetVersion sets field value.

type ClusterMajorVersionSupportStatusType added in v1.0.0 

type ClusterMajorVersionSupportStatusType string

ClusterMajorVersionSupportStatusType the model 'ClusterMajorVersionSupportStatusType'. 

const (
	CLUSTERMAJORVERSIONSUPPORTSTATUSTYPE_UNSUPPORTED ClusterMajorVersionSupportStatusType = "UNSUPPORTED"
	CLUSTERMAJORVERSIONSUPPORTSTATUSTYPE_SUPPORTED   ClusterMajorVersionSupportStatusType = "SUPPORTED"
	CLUSTERMAJORVERSIONSUPPORTSTATUSTYPE_PREVIEW     ClusterMajorVersionSupportStatusType = "PREVIEW"
)

List of ClusterMajorVersionSupportStatus.Type.

func NewClusterMajorVersionSupportStatusTypeFromValue added in v1.0.0 

func NewClusterMajorVersionSupportStatusTypeFromValue(v string) (*ClusterMajorVersionSupportStatusType, error)

NewClusterMajorVersionSupportStatusTypeFromValue returns a pointer to a valid ClusterMajorVersionSupportStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClusterMajorVersionSupportStatusType) IsValid added in v1.0.0 

func (v ClusterMajorVersionSupportStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClusterMajorVersionSupportStatusType) Ptr added in v1.0.0 

func (v ClusterMajorVersionSupportStatusType) Ptr() *ClusterMajorVersionSupportStatusType

Ptr returns reference to ClusterMajorVersionSupportStatus.Type value.

type ClusterStateType 

type ClusterStateType string

ClusterStateType - LOCKED: An exclusive operation is being performed on this cluster. Other operations should not proceed if they did not set a cluster into the LOCKED state. 

const (
	CLUSTERSTATETYPE_CREATING        ClusterStateType = "CREATING"
	CLUSTERSTATETYPE_CREATED         ClusterStateType = "CREATED"
	CLUSTERSTATETYPE_CREATION_FAILED ClusterStateType = "CREATION_FAILED"
	CLUSTERSTATETYPE_DELETED         ClusterStateType = "DELETED"
	CLUSTERSTATETYPE_LOCKED          ClusterStateType = "LOCKED"
)

List of ClusterState.Type.

func NewClusterStateTypeFromValue 

func NewClusterStateTypeFromValue(v string) (*ClusterStateType, error)

NewClusterStateTypeFromValue returns a pointer to a valid ClusterStateType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClusterStateType) IsValid 

func (v ClusterStateType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClusterStateType) Ptr 

func (v ClusterStateType) Ptr() *ClusterStateType

Ptr returns reference to ClusterState.Type value.

type ClusterStatusType 

type ClusterStatusType string

ClusterStatusType the model 'ClusterStatusType'. 

const (
	CLUSTERSTATUSTYPE_UNSPECIFIED                            ClusterStatusType = "UNSPECIFIED"
	CLUSTERSTATUSTYPE_CRDB_MAJOR_UPGRADE_RUNNING             ClusterStatusType = "CRDB_MAJOR_UPGRADE_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_MAJOR_UPGRADE_FAILED              ClusterStatusType = "CRDB_MAJOR_UPGRADE_FAILED"
	CLUSTERSTATUSTYPE_CRDB_MAJOR_ROLLBACK_RUNNING            ClusterStatusType = "CRDB_MAJOR_ROLLBACK_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_MAJOR_ROLLBACK_FAILED             ClusterStatusType = "CRDB_MAJOR_ROLLBACK_FAILED"
	CLUSTERSTATUSTYPE_CRDB_PATCH_RUNNING                     ClusterStatusType = "CRDB_PATCH_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_PATCH_FAILED                      ClusterStatusType = "CRDB_PATCH_FAILED"
	CLUSTERSTATUSTYPE_CRDB_SCALE_RUNNING                     ClusterStatusType = "CRDB_SCALE_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_SCALE_FAILED                      ClusterStatusType = "CRDB_SCALE_FAILED"
	CLUSTERSTATUSTYPE_MAINTENANCE_RUNNING                    ClusterStatusType = "MAINTENANCE_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_INSTANCE_UPDATE_RUNNING           ClusterStatusType = "CRDB_INSTANCE_UPDATE_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_INSTANCE_UPDATE_FAILED            ClusterStatusType = "CRDB_INSTANCE_UPDATE_FAILED"
	CLUSTERSTATUSTYPE_CRDB_EDIT_CLUSTER_RUNNING              ClusterStatusType = "CRDB_EDIT_CLUSTER_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_EDIT_CLUSTER_FAILED               ClusterStatusType = "CRDB_EDIT_CLUSTER_FAILED"
	CLUSTERSTATUSTYPE_CRDB_CMEK_OPERATION_RUNNING            ClusterStatusType = "CRDB_CMEK_OPERATION_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_CMEK_OPERATION_FAILED             ClusterStatusType = "CRDB_CMEK_OPERATION_FAILED"
	CLUSTERSTATUSTYPE_TENANT_RESTORE_RUNNING                 ClusterStatusType = "TENANT_RESTORE_RUNNING"
	CLUSTERSTATUSTYPE_TENANT_RESTORE_FAILED                  ClusterStatusType = "TENANT_RESTORE_FAILED"
	CLUSTERSTATUSTYPE_CRDB_LOG_EXPORT_OPERATION_RUNNING      ClusterStatusType = "CRDB_LOG_EXPORT_OPERATION_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_LOG_EXPORT_OPERATION_FAILED       ClusterStatusType = "CRDB_LOG_EXPORT_OPERATION_FAILED"
	CLUSTERSTATUSTYPE_CRDB_CLUSTER_DISRUPTION_RUNNING        ClusterStatusType = "CRDB_CLUSTER_DISRUPTION_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_CLUSTER_DISRUPTION_FAILED         ClusterStatusType = "CRDB_CLUSTER_DISRUPTION_FAILED"
	CLUSTERSTATUSTYPE_CRDB_REPAVE_RUNNING                    ClusterStatusType = "CRDB_REPAVE_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_REPAVE_FAILED                     ClusterStatusType = "CRDB_REPAVE_FAILED"
	CLUSTERSTATUSTYPE_CRDB_CUSTOM_CLIENT_CA_RUNNING          ClusterStatusType = "CRDB_CUSTOM_CLIENT_CA_RUNNING"
	CLUSTERSTATUSTYPE_CRDB_CUSTOM_CLIENT_CA_FAILED           ClusterStatusType = "CRDB_CUSTOM_CLIENT_CA_FAILED"
	CLUSTERSTATUSTYPE_DEDICATED_FULL_CLUSTER_RESTORE_RUNNING ClusterStatusType = "DEDICATED_FULL_CLUSTER_RESTORE_RUNNING"
	CLUSTERSTATUSTYPE_DEDICATED_FULL_CLUSTER_RESTORE_FAILED  ClusterStatusType = "DEDICATED_FULL_CLUSTER_RESTORE_FAILED"
)

List of ClusterStatus.Type.

func NewClusterStatusTypeFromValue 

func NewClusterStatusTypeFromValue(v string) (*ClusterStatusType, error)

NewClusterStatusTypeFromValue returns a pointer to a valid ClusterStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClusterStatusType) IsValid 

func (v ClusterStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClusterStatusType) Ptr 

func (v ClusterStatusType) Ptr() *ClusterStatusType

Ptr returns reference to ClusterStatus.Type value.

type ClusterUpgradeStatusType added in v1.0.0 

type ClusterUpgradeStatusType string

ClusterUpgradeStatusType - FINALIZED: The cluster is running the latest available CockroachDB version, and all upgrades have been finalized. - MAJOR_UPGRADE_RUNNING: An major version upgrade is currently in progress. - UPGRADE_AVAILABLE: An upgrade is available. If preview builds are enabled for the parent organization, this could indicate that a preview upgrade is available. - PENDING_FINALIZATION: An upgrade is complete, but pending finalization. Upgrades are automatically finalized after 72 hours. For more information, see https://www.cockroachlabs.com/docs/stable/upgrade-cockroach-version.html - ROLLBACK_RUNNING: A rollback operation is currently in progress. 

const (
	CLUSTERUPGRADESTATUSTYPE_FINALIZED             ClusterUpgradeStatusType = "FINALIZED"
	CLUSTERUPGRADESTATUSTYPE_MAJOR_UPGRADE_RUNNING ClusterUpgradeStatusType = "MAJOR_UPGRADE_RUNNING"
	CLUSTERUPGRADESTATUSTYPE_UPGRADE_AVAILABLE     ClusterUpgradeStatusType = "UPGRADE_AVAILABLE"
	CLUSTERUPGRADESTATUSTYPE_PENDING_FINALIZATION  ClusterUpgradeStatusType = "PENDING_FINALIZATION"
	CLUSTERUPGRADESTATUSTYPE_ROLLBACK_RUNNING      ClusterUpgradeStatusType = "ROLLBACK_RUNNING"
)

List of ClusterUpgradeStatus.Type.

func NewClusterUpgradeStatusTypeFromValue added in v1.0.0 

func NewClusterUpgradeStatusTypeFromValue(v string) (*ClusterUpgradeStatusType, error)

NewClusterUpgradeStatusTypeFromValue returns a pointer to a valid ClusterUpgradeStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClusterUpgradeStatusType) IsValid added in v1.0.0 

func (v ClusterUpgradeStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClusterUpgradeStatusType) Ptr added in v1.0.0 

func (v ClusterUpgradeStatusType) Ptr() *ClusterUpgradeStatusType

Ptr returns reference to ClusterUpgradeStatus.Type value.

type ClusterVersionDeferral added in v1.2.0 

type ClusterVersionDeferral struct {
	DeferralPolicy ClusterVersionDeferralPolicyType `json:"deferral_policy"`
}

ClusterVersionDeferral ClusterVersionDeferral specifies whether automatic patch version upgrades are applied immediately or deferred. If upgrades are deferred, the cluster will be automatically upgraded to each patch version 60 days after the version is released to CockroachDB Cloud..

func NewClusterVersionDeferral added in v1.2.0 

func NewClusterVersionDeferral(deferralPolicy ClusterVersionDeferralPolicyType) *ClusterVersionDeferral

NewClusterVersionDeferral instantiates a new ClusterVersionDeferral object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewClusterVersionDeferralWithDefaults added in v1.2.0 

func NewClusterVersionDeferralWithDefaults() *ClusterVersionDeferral

NewClusterVersionDeferralWithDefaults instantiates a new ClusterVersionDeferral object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ClusterVersionDeferral) GetDeferralPolicy added in v1.2.0 

func (o *ClusterVersionDeferral) GetDeferralPolicy() ClusterVersionDeferralPolicyType

GetDeferralPolicy returns the DeferralPolicy field value.

func (*ClusterVersionDeferral) SetDeferralPolicy added in v1.2.0 

func (o *ClusterVersionDeferral) SetDeferralPolicy(v ClusterVersionDeferralPolicyType)

SetDeferralPolicy sets field value.

type ClusterVersionDeferralPolicyType added in v1.2.0 

type ClusterVersionDeferralPolicyType string

ClusterVersionDeferralPolicyType the model 'ClusterVersionDeferralPolicyType'. 

const (
	CLUSTERVERSIONDEFERRALPOLICYTYPE_NOT_DEFERRED   ClusterVersionDeferralPolicyType = "NOT_DEFERRED"
	CLUSTERVERSIONDEFERRALPOLICYTYPE_FIXED_DEFERRAL ClusterVersionDeferralPolicyType = "FIXED_DEFERRAL"
)

List of ClusterVersionDeferralPolicy.Type.

func NewClusterVersionDeferralPolicyTypeFromValue added in v1.2.0 

func NewClusterVersionDeferralPolicyTypeFromValue(v string) (*ClusterVersionDeferralPolicyType, error)

NewClusterVersionDeferralPolicyTypeFromValue returns a pointer to a valid ClusterVersionDeferralPolicyType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ClusterVersionDeferralPolicyType) IsValid added in v1.2.0 

func (v ClusterVersionDeferralPolicyType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ClusterVersionDeferralPolicyType) Ptr added in v1.2.0 

func (v ClusterVersionDeferralPolicyType) Ptr() *ClusterVersionDeferralPolicyType

Ptr returns reference to ClusterVersionDeferralPolicy.Type value.

type CockroachCloudSetRolesForUserRequest added in v0.4.4 

type CockroachCloudSetRolesForUserRequest struct {
	Roles []BuiltInRole `json:"roles"`
}

CockroachCloudSetRolesForUserRequest struct for CockroachCloudSetRolesForUserRequest.

func NewCockroachCloudSetRolesForUserRequest added in v0.4.4 

func NewCockroachCloudSetRolesForUserRequest(roles []BuiltInRole) *CockroachCloudSetRolesForUserRequest

NewCockroachCloudSetRolesForUserRequest instantiates a new CockroachCloudSetRolesForUserRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCockroachCloudSetRolesForUserRequestWithDefaults added in v0.4.4 

func NewCockroachCloudSetRolesForUserRequestWithDefaults() *CockroachCloudSetRolesForUserRequest

NewCockroachCloudSetRolesForUserRequestWithDefaults instantiates a new CockroachCloudSetRolesForUserRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CockroachCloudSetRolesForUserRequest) GetRoles added in v0.4.4 

func (o *CockroachCloudSetRolesForUserRequest) GetRoles() []BuiltInRole

GetRoles returns the Roles field value.

func (*CockroachCloudSetRolesForUserRequest) SetRoles added in v0.4.4 

func (o *CockroachCloudSetRolesForUserRequest) SetRoles(v []BuiltInRole)

SetRoles sets field value.

type Configuration 

type Configuration struct {
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	ServerURL     string
	HTTPClient    *http.Client
	// contains filtered or unexported fields
}

Configuration stores the configuration of the API client.

func NewConfiguration 

func NewConfiguration(apiKey string) *Configuration

NewConfiguration returns a new Configuration object.

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request.

type ConnectionStringParameters added in v1.4.0 

type ConnectionStringParameters struct {
	Database string  `json:"Database"`
	Host     string  `json:"Host"`
	Port     string  `json:"Port"`
	Username *string `json:"Username,omitempty"`
}

ConnectionStringParameters Individual parameters used to create a connection string..

func NewConnectionStringParameters added in v1.4.0 

func NewConnectionStringParameters(database string, host string, port string) *ConnectionStringParameters

NewConnectionStringParameters instantiates a new ConnectionStringParameters object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewConnectionStringParametersWithDefaults added in v1.4.0 

func NewConnectionStringParametersWithDefaults() *ConnectionStringParameters

NewConnectionStringParametersWithDefaults instantiates a new ConnectionStringParameters object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ConnectionStringParameters) GetDatabase added in v1.4.0 

func (o *ConnectionStringParameters) GetDatabase() string

GetDatabase returns the Database field value.

func (*ConnectionStringParameters) GetHost added in v1.4.0 

func (o *ConnectionStringParameters) GetHost() string

GetHost returns the Host field value.

func (*ConnectionStringParameters) GetPort added in v1.4.0 

func (o *ConnectionStringParameters) GetPort() string

GetPort returns the Port field value.

func (*ConnectionStringParameters) GetUsername added in v1.4.0 

func (o *ConnectionStringParameters) GetUsername() string

GetUsername returns the Username field value if set, zero value otherwise.

func (*ConnectionStringParameters) SetDatabase added in v1.4.0 

func (o *ConnectionStringParameters) SetDatabase(v string)

SetDatabase sets field value.

func (*ConnectionStringParameters) SetHost added in v1.4.0 

func (o *ConnectionStringParameters) SetHost(v string)

SetHost sets field value.

func (*ConnectionStringParameters) SetPort added in v1.4.0 

func (o *ConnectionStringParameters) SetPort(v string)

SetPort sets field value.

func (*ConnectionStringParameters) SetUsername added in v1.4.0 

func (o *ConnectionStringParameters) SetUsername(v string)

SetUsername gets a reference to the given string and assigns it to the Username field.

type CreateApiKeyRequest added in v1.11.0 

type CreateApiKeyRequest struct {
	// The name of the api key.
	Name string `json:"name"`
	// The ID of the service account to create the api key for.
	ServiceAccountId string `json:"service_account_id"`
}

CreateApiKeyRequest struct for CreateApiKeyRequest.

func NewCreateApiKeyRequest added in v1.11.0 

func NewCreateApiKeyRequest(name string, serviceAccountId string) *CreateApiKeyRequest

NewCreateApiKeyRequest instantiates a new CreateApiKeyRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateApiKeyRequestWithDefaults added in v1.11.0 

func NewCreateApiKeyRequestWithDefaults() *CreateApiKeyRequest

NewCreateApiKeyRequestWithDefaults instantiates a new CreateApiKeyRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateApiKeyRequest) GetName added in v1.11.0 

func (o *CreateApiKeyRequest) GetName() string

GetName returns the Name field value.

func (*CreateApiKeyRequest) GetServiceAccountId added in v1.11.0 

func (o *CreateApiKeyRequest) GetServiceAccountId() string

GetServiceAccountId returns the ServiceAccountId field value.

func (*CreateApiKeyRequest) SetName added in v1.11.0 

func (o *CreateApiKeyRequest) SetName(v string)

SetName sets field value.

func (*CreateApiKeyRequest) SetServiceAccountId added in v1.11.0 

func (o *CreateApiKeyRequest) SetServiceAccountId(v string)

SetServiceAccountId sets field value.

type CreateApiKeyResponse added in v1.11.0 

type CreateApiKeyResponse struct {
	ApiKey ApiKey `json:"api_key"`
	// The full api key. This is the value that would be passed in the Authorization header. It is not stored by the backend and is therefore not recoverable if lost.
	Secret string `json:"secret"`
}

CreateApiKeyResponse struct for CreateApiKeyResponse.

func NewCreateApiKeyResponse added in v1.11.0 

func NewCreateApiKeyResponse(apiKey ApiKey, secret string) *CreateApiKeyResponse

NewCreateApiKeyResponse instantiates a new CreateApiKeyResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateApiKeyResponseWithDefaults added in v1.11.0 

func NewCreateApiKeyResponseWithDefaults() *CreateApiKeyResponse

NewCreateApiKeyResponseWithDefaults instantiates a new CreateApiKeyResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateApiKeyResponse) GetApiKey added in v1.11.0 

func (o *CreateApiKeyResponse) GetApiKey() ApiKey

GetApiKey returns the ApiKey field value.

func (*CreateApiKeyResponse) GetSecret added in v1.11.0 

func (o *CreateApiKeyResponse) GetSecret() string

GetSecret returns the Secret field value.

func (*CreateApiKeyResponse) SetApiKey added in v1.11.0 

func (o *CreateApiKeyResponse) SetApiKey(v ApiKey)

SetApiKey sets field value.

func (*CreateApiKeyResponse) SetSecret added in v1.11.0 

func (o *CreateApiKeyResponse) SetSecret(v string)

SetSecret sets field value.

type CreateApiOidcConfigRequest added in v1.5.0 

type CreateApiOidcConfigRequest struct {
	Audience    string                     `json:"audience"`
	Claim       *string                    `json:"claim,omitempty"`
	IdentityMap *[]ApiOidcIdentityMapEntry `json:"identity_map,omitempty"`
	Issuer      string                     `json:"issuer"`
	Jwks        string                     `json:"jwks"`
}

CreateApiOidcConfigRequest struct for CreateApiOidcConfigRequest.

func NewCreateApiOidcConfigRequest added in v1.5.0 

func NewCreateApiOidcConfigRequest(audience string, issuer string, jwks string) *CreateApiOidcConfigRequest

NewCreateApiOidcConfigRequest instantiates a new CreateApiOidcConfigRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateApiOidcConfigRequestWithDefaults added in v1.5.0 

func NewCreateApiOidcConfigRequestWithDefaults() *CreateApiOidcConfigRequest

NewCreateApiOidcConfigRequestWithDefaults instantiates a new CreateApiOidcConfigRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateApiOidcConfigRequest) GetAudience added in v1.5.0 

func (o *CreateApiOidcConfigRequest) GetAudience() string

GetAudience returns the Audience field value.

func (*CreateApiOidcConfigRequest) GetClaim added in v1.5.0 

func (o *CreateApiOidcConfigRequest) GetClaim() string

GetClaim returns the Claim field value if set, zero value otherwise.

func (*CreateApiOidcConfigRequest) GetIdentityMap added in v1.5.0 

func (o *CreateApiOidcConfigRequest) GetIdentityMap() []ApiOidcIdentityMapEntry

GetIdentityMap returns the IdentityMap field value if set, zero value otherwise.

func (*CreateApiOidcConfigRequest) GetIssuer added in v1.5.0 

func (o *CreateApiOidcConfigRequest) GetIssuer() string

GetIssuer returns the Issuer field value.

func (*CreateApiOidcConfigRequest) GetJwks added in v1.5.0 

func (o *CreateApiOidcConfigRequest) GetJwks() string

GetJwks returns the Jwks field value.

func (*CreateApiOidcConfigRequest) SetAudience added in v1.5.0 

func (o *CreateApiOidcConfigRequest) SetAudience(v string)

SetAudience sets field value.

func (*CreateApiOidcConfigRequest) SetClaim added in v1.5.0 

func (o *CreateApiOidcConfigRequest) SetClaim(v string)

SetClaim gets a reference to the given string and assigns it to the Claim field.

func (*CreateApiOidcConfigRequest) SetIdentityMap added in v1.5.0 

func (o *CreateApiOidcConfigRequest) SetIdentityMap(v []ApiOidcIdentityMapEntry)

SetIdentityMap gets a reference to the given []ApiOidcIdentityMapEntry and assigns it to the IdentityMap field.

func (*CreateApiOidcConfigRequest) SetIssuer added in v1.5.0 

func (o *CreateApiOidcConfigRequest) SetIssuer(v string)

SetIssuer sets field value.

func (*CreateApiOidcConfigRequest) SetJwks added in v1.5.0 

func (o *CreateApiOidcConfigRequest) SetJwks(v string)

SetJwks sets field value.

type CreateClusterRequest 

type CreateClusterRequest struct {
	// Name must be 6-20 characters in length and can include numbers, lowercase letters, and dashes (but no leading or trailing dashes).
	Name     string                     `json:"name"`
	Provider CloudProviderType          `json:"provider"`
	Spec     CreateClusterSpecification `json:"spec"`
}

CreateClusterRequest struct for CreateClusterRequest.

func NewCreateClusterRequest 

func NewCreateClusterRequest(name string, provider CloudProviderType, spec CreateClusterSpecification) *CreateClusterRequest

NewCreateClusterRequest instantiates a new CreateClusterRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateClusterRequestWithDefaults 

func NewCreateClusterRequestWithDefaults() *CreateClusterRequest

NewCreateClusterRequestWithDefaults instantiates a new CreateClusterRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateClusterRequest) GetName 

func (o *CreateClusterRequest) GetName() string

GetName returns the Name field value.

func (*CreateClusterRequest) GetProvider 

func (o *CreateClusterRequest) GetProvider() CloudProviderType

GetProvider returns the Provider field value.

func (*CreateClusterRequest) GetSpec 

func (o *CreateClusterRequest) GetSpec() CreateClusterSpecification

GetSpec returns the Spec field value.

func (*CreateClusterRequest) SetName 

func (o *CreateClusterRequest) SetName(v string)

SetName sets field value.

func (*CreateClusterRequest) SetProvider 

func (o *CreateClusterRequest) SetProvider(v CloudProviderType)

SetProvider sets field value.

func (*CreateClusterRequest) SetSpec 

func (o *CreateClusterRequest) SetSpec(v CreateClusterSpecification)

SetSpec sets field value.

type CreateClusterSpecification 

type CreateClusterSpecification struct {
	Dedicated        *DedicatedClusterCreateSpecification `json:"dedicated,omitempty"`
	DeleteProtection *DeleteProtectionStateType           `json:"delete_protection,omitempty"`
	// Limited Access: The parent ID is a folder ID. An empty string or \"root\" will create a cluster at the root level.
	ParentId   *string                               `json:"parent_id,omitempty"`
	Serverless *ServerlessClusterCreateSpecification `json:"serverless,omitempty"`
}

CreateClusterSpecification struct for CreateClusterSpecification.

func NewCreateClusterSpecification 

func NewCreateClusterSpecification() *CreateClusterSpecification

NewCreateClusterSpecification instantiates a new CreateClusterSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CreateClusterSpecification) GetDedicated 

func (o *CreateClusterSpecification) GetDedicated() DedicatedClusterCreateSpecification

GetDedicated returns the Dedicated field value if set, zero value otherwise.

func (*CreateClusterSpecification) GetDeleteProtection added in v1.11.0 

func (o *CreateClusterSpecification) GetDeleteProtection() DeleteProtectionStateType

GetDeleteProtection returns the DeleteProtection field value if set, zero value otherwise.

func (*CreateClusterSpecification) GetParentId added in v1.4.0 

func (o *CreateClusterSpecification) GetParentId() string

GetParentId returns the ParentId field value if set, zero value otherwise.

func (*CreateClusterSpecification) GetServerless 

func (o *CreateClusterSpecification) GetServerless() ServerlessClusterCreateSpecification

GetServerless returns the Serverless field value if set, zero value otherwise.

func (*CreateClusterSpecification) SetDedicated 

func (o *CreateClusterSpecification) SetDedicated(v DedicatedClusterCreateSpecification)

SetDedicated gets a reference to the given DedicatedClusterCreateSpecification and assigns it to the Dedicated field.

func (*CreateClusterSpecification) SetDeleteProtection added in v1.11.0 

func (o *CreateClusterSpecification) SetDeleteProtection(v DeleteProtectionStateType)

SetDeleteProtection gets a reference to the given DeleteProtectionStateType and assigns it to the DeleteProtection field.

func (*CreateClusterSpecification) SetParentId added in v1.4.0 

func (o *CreateClusterSpecification) SetParentId(v string)

SetParentId gets a reference to the given string and assigns it to the ParentId field.

func (*CreateClusterSpecification) SetServerless 

func (o *CreateClusterSpecification) SetServerless(v ServerlessClusterCreateSpecification)

SetServerless gets a reference to the given ServerlessClusterCreateSpecification and assigns it to the Serverless field.

type CreateDatabaseRequest 

type CreateDatabaseRequest struct {
	Name string `json:"name"`
}

CreateDatabaseRequest struct for CreateDatabaseRequest.

func NewCreateDatabaseRequest 

func NewCreateDatabaseRequest(name string) *CreateDatabaseRequest

NewCreateDatabaseRequest instantiates a new CreateDatabaseRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateDatabaseRequestWithDefaults 

func NewCreateDatabaseRequestWithDefaults() *CreateDatabaseRequest

NewCreateDatabaseRequestWithDefaults instantiates a new CreateDatabaseRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateDatabaseRequest) GetName 

func (o *CreateDatabaseRequest) GetName() string

GetName returns the Name field value.

func (*CreateDatabaseRequest) SetName 

func (o *CreateDatabaseRequest) SetName(v string)

SetName sets field value.

type CreateFolderRequest added in v1.4.0 

type CreateFolderRequest struct {
	Name string `json:"name"`
	// The parent ID is a folder ID. An empty string or \"root\" will create a folder at the root level.
	ParentId *string `json:"parent_id,omitempty"`
}

CreateFolderRequest struct for CreateFolderRequest.

func NewCreateFolderRequest added in v1.4.0 

func NewCreateFolderRequest(name string) *CreateFolderRequest

NewCreateFolderRequest instantiates a new CreateFolderRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateFolderRequestWithDefaults added in v1.4.0 

func NewCreateFolderRequestWithDefaults() *CreateFolderRequest

NewCreateFolderRequestWithDefaults instantiates a new CreateFolderRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateFolderRequest) GetName added in v1.4.0 

func (o *CreateFolderRequest) GetName() string

GetName returns the Name field value.

func (*CreateFolderRequest) GetParentId added in v1.4.0 

func (o *CreateFolderRequest) GetParentId() string

GetParentId returns the ParentId field value if set, zero value otherwise.

func (*CreateFolderRequest) SetName added in v1.4.0 

func (o *CreateFolderRequest) SetName(v string)

SetName sets field value.

func (*CreateFolderRequest) SetParentId added in v1.4.0 

func (o *CreateFolderRequest) SetParentId(v string)

SetParentId gets a reference to the given string and assigns it to the ParentId field.

type CreateGroupRequest added in v1.1.0 

type CreateGroupRequest struct {
	DisplayName string          `json:"displayName"`
	ExternalId  *string         `json:"externalId,omitempty"`
	Members     *[]ScimResource `json:"members,omitempty"`
	Schemas     *[]string       `json:"schemas,omitempty"`
}

CreateGroupRequest struct for CreateGroupRequest.

func NewCreateGroupRequest added in v1.1.0 

func NewCreateGroupRequest(displayName string) *CreateGroupRequest

NewCreateGroupRequest instantiates a new CreateGroupRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateGroupRequestWithDefaults added in v1.1.0 

func NewCreateGroupRequestWithDefaults() *CreateGroupRequest

NewCreateGroupRequestWithDefaults instantiates a new CreateGroupRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateGroupRequest) GetDisplayName added in v1.1.0 

func (o *CreateGroupRequest) GetDisplayName() string

GetDisplayName returns the DisplayName field value.

func (*CreateGroupRequest) GetExternalId added in v1.1.0 

func (o *CreateGroupRequest) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*CreateGroupRequest) GetMembers added in v1.1.0 

func (o *CreateGroupRequest) GetMembers() []ScimResource

GetMembers returns the Members field value if set, zero value otherwise.

func (*CreateGroupRequest) GetSchemas added in v1.1.0 

func (o *CreateGroupRequest) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*CreateGroupRequest) SetDisplayName added in v1.1.0 

func (o *CreateGroupRequest) SetDisplayName(v string)

SetDisplayName sets field value.

func (*CreateGroupRequest) SetExternalId added in v1.1.0 

func (o *CreateGroupRequest) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*CreateGroupRequest) SetMembers added in v1.1.0 

func (o *CreateGroupRequest) SetMembers(v []ScimResource)

SetMembers gets a reference to the given []ScimResource and assigns it to the Members field.

func (*CreateGroupRequest) SetSchemas added in v1.1.0 

func (o *CreateGroupRequest) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

type CreateSQLUserRequest 

type CreateSQLUserRequest struct {
	Name     string `json:"name"`
	Password string `json:"password"`
}

CreateSQLUserRequest struct for CreateSQLUserRequest.

func NewCreateSQLUserRequest 

func NewCreateSQLUserRequest(name string, password string) *CreateSQLUserRequest

NewCreateSQLUserRequest instantiates a new CreateSQLUserRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateSQLUserRequestWithDefaults 

func NewCreateSQLUserRequestWithDefaults() *CreateSQLUserRequest

NewCreateSQLUserRequestWithDefaults instantiates a new CreateSQLUserRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateSQLUserRequest) GetName 

func (o *CreateSQLUserRequest) GetName() string

GetName returns the Name field value.

func (*CreateSQLUserRequest) GetPassword 

func (o *CreateSQLUserRequest) GetPassword() string

GetPassword returns the Password field value.

func (*CreateSQLUserRequest) SetName 

func (o *CreateSQLUserRequest) SetName(v string)

SetName sets field value.

func (*CreateSQLUserRequest) SetPassword 

func (o *CreateSQLUserRequest) SetPassword(v string)

SetPassword sets field value.

type CreateServiceAccountRequest added in v1.11.0 

type CreateServiceAccountRequest struct {
	// description of the service account.
	Description string `json:"description"`
	// name of the service account.
	Name string `json:"name"`
	// roles that are assigned to the service account.
	Roles []BuiltInRole `json:"roles"`
}

CreateServiceAccountRequest struct for CreateServiceAccountRequest.

func NewCreateServiceAccountRequest added in v1.11.0 

func NewCreateServiceAccountRequest(description string, name string, roles []BuiltInRole) *CreateServiceAccountRequest

NewCreateServiceAccountRequest instantiates a new CreateServiceAccountRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateServiceAccountRequestWithDefaults added in v1.11.0 

func NewCreateServiceAccountRequestWithDefaults() *CreateServiceAccountRequest

NewCreateServiceAccountRequestWithDefaults instantiates a new CreateServiceAccountRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateServiceAccountRequest) GetDescription added in v1.11.0 

func (o *CreateServiceAccountRequest) GetDescription() string

GetDescription returns the Description field value.

func (*CreateServiceAccountRequest) GetName added in v1.11.0 

func (o *CreateServiceAccountRequest) GetName() string

GetName returns the Name field value.

func (*CreateServiceAccountRequest) GetRoles added in v1.11.0 

func (o *CreateServiceAccountRequest) GetRoles() []BuiltInRole

GetRoles returns the Roles field value.

func (*CreateServiceAccountRequest) SetDescription added in v1.11.0 

func (o *CreateServiceAccountRequest) SetDescription(v string)

SetDescription sets field value.

func (*CreateServiceAccountRequest) SetName added in v1.11.0 

func (o *CreateServiceAccountRequest) SetName(v string)

SetName sets field value.

func (*CreateServiceAccountRequest) SetRoles added in v1.11.0 

func (o *CreateServiceAccountRequest) SetRoles(v []BuiltInRole)

SetRoles sets field value.

type CreateUserRequest added in v1.1.0 

type CreateUserRequest struct {
	Active      bool        `json:"active"`
	DisplayName string      `json:"displayName"`
	Emails      []ScimEmail `json:"emails"`
	ExternalId  *string     `json:"externalId,omitempty"`
	Name        ScimName    `json:"name"`
	Schemas     *[]string   `json:"schemas,omitempty"`
	UserName    *string     `json:"userName,omitempty"`
}

CreateUserRequest struct for CreateUserRequest.

func NewCreateUserRequest added in v1.1.0 

func NewCreateUserRequest(active bool, displayName string, emails []ScimEmail, name ScimName) *CreateUserRequest

NewCreateUserRequest instantiates a new CreateUserRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateUserRequestWithDefaults added in v1.1.0 

func NewCreateUserRequestWithDefaults() *CreateUserRequest

NewCreateUserRequestWithDefaults instantiates a new CreateUserRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateUserRequest) GetActive added in v1.1.0 

func (o *CreateUserRequest) GetActive() bool

GetActive returns the Active field value.

func (*CreateUserRequest) GetDisplayName added in v1.1.0 

func (o *CreateUserRequest) GetDisplayName() string

GetDisplayName returns the DisplayName field value.

func (*CreateUserRequest) GetEmails added in v1.1.0 

func (o *CreateUserRequest) GetEmails() []ScimEmail

GetEmails returns the Emails field value.

func (*CreateUserRequest) GetExternalId added in v1.1.0 

func (o *CreateUserRequest) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*CreateUserRequest) GetName added in v1.1.0 

func (o *CreateUserRequest) GetName() ScimName

GetName returns the Name field value.

func (*CreateUserRequest) GetSchemas added in v1.1.0 

func (o *CreateUserRequest) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*CreateUserRequest) GetUserName added in v1.1.0 

func (o *CreateUserRequest) GetUserName() string

GetUserName returns the UserName field value if set, zero value otherwise.

func (*CreateUserRequest) SetActive added in v1.1.0 

func (o *CreateUserRequest) SetActive(v bool)

SetActive sets field value.

func (*CreateUserRequest) SetDisplayName added in v1.1.0 

func (o *CreateUserRequest) SetDisplayName(v string)

SetDisplayName sets field value.

func (*CreateUserRequest) SetEmails added in v1.1.0 

func (o *CreateUserRequest) SetEmails(v []ScimEmail)

SetEmails sets field value.

func (*CreateUserRequest) SetExternalId added in v1.1.0 

func (o *CreateUserRequest) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*CreateUserRequest) SetName added in v1.1.0 

func (o *CreateUserRequest) SetName(v ScimName)

SetName sets field value.

func (*CreateUserRequest) SetSchemas added in v1.1.0 

func (o *CreateUserRequest) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*CreateUserRequest) SetUserName added in v1.1.0 

func (o *CreateUserRequest) SetUserName(v string)

SetUserName gets a reference to the given string and assigns it to the UserName field.

type CurrencyAmount 

type CurrencyAmount struct {
	// amount is the quantity of currency. Internally, currency amounts are tracked and stored using an arbitrary-precision decimal representation, but are serialized as 64-bit floating point numbers. There may be minor rounding discrepancies when parsed as a 32-bit float.
	Amount   *float64      `json:"amount,omitempty"`
	Currency *CurrencyType `json:"currency,omitempty"`
}

CurrencyAmount struct for CurrencyAmount.

func NewCurrencyAmount 

func NewCurrencyAmount() *CurrencyAmount

NewCurrencyAmount instantiates a new CurrencyAmount object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*CurrencyAmount) GetAmount 

func (o *CurrencyAmount) GetAmount() float64

GetAmount returns the Amount field value if set, zero value otherwise.

func (*CurrencyAmount) GetCurrency 

func (o *CurrencyAmount) GetCurrency() CurrencyType

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*CurrencyAmount) SetAmount 

func (o *CurrencyAmount) SetAmount(v float64)

SetAmount gets a reference to the given float64 and assigns it to the Amount field.

func (*CurrencyAmount) SetCurrency 

func (o *CurrencyAmount) SetCurrency(v CurrencyType)

SetCurrency gets a reference to the given CurrencyType and assigns it to the Currency field.

type CurrencyType added in v1.0.0 

type CurrencyType string

CurrencyType the model 'CurrencyType'. 

const (
	CURRENCYTYPE_USD                CurrencyType = "USD"
	CURRENCYTYPE_CRDB_CLOUD_CREDITS CurrencyType = "CRDB_CLOUD_CREDITS"
)

List of Currency.Type.

func NewCurrencyTypeFromValue added in v1.0.0 

func NewCurrencyTypeFromValue(v string) (*CurrencyType, error)

NewCurrencyTypeFromValue returns a pointer to a valid CurrencyType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (CurrencyType) IsValid added in v1.0.0 

func (v CurrencyType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (CurrencyType) Ptr added in v1.0.0 

func (v CurrencyType) Ptr() *CurrencyType

Ptr returns reference to Currency.Type value.

type Database added in v1.8.0 

type Database struct {
	Name       string `json:"name"`
	TableCount *int64 `json:"table_count,omitempty,string"`
}

Database struct for Database.

func NewDatabase added in v1.8.0 

func NewDatabase(name string) *Database

NewDatabase instantiates a new Database object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDatabaseWithDefaults added in v1.8.0 

func NewDatabaseWithDefaults() *Database

NewDatabaseWithDefaults instantiates a new Database object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Database) GetName added in v1.8.0 

func (o *Database) GetName() string

GetName returns the Name field value.

func (*Database) GetTableCount added in v1.8.0 

func (o *Database) GetTableCount() int64

GetTableCount returns the TableCount field value if set, zero value otherwise.

func (*Database) SetName added in v1.8.0 

func (o *Database) SetName(v string)

SetName sets field value.

func (*Database) SetTableCount added in v1.8.0 

func (o *Database) SetTableCount(v int64)

SetTableCount gets a reference to the given int64 and assigns it to the TableCount field.

type DatadogMetricExportInfo added in v0.4.3 

type DatadogMetricExportInfo struct {
	// api_key is the last 4 digits of a Datadog API key.
	ApiKey      *string                 `json:"api_key,omitempty"`
	ClusterId   string                  `json:"cluster_id"`
	Site        DatadogSiteType         `json:"site"`
	Status      *MetricExportStatusType `json:"status,omitempty"`
	UserMessage *string                 `json:"user_message,omitempty"`
}

DatadogMetricExportInfo struct for DatadogMetricExportInfo.

func NewDatadogMetricExportInfo added in v0.4.3 

func NewDatadogMetricExportInfo(clusterId string, site DatadogSiteType) *DatadogMetricExportInfo

NewDatadogMetricExportInfo instantiates a new DatadogMetricExportInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDatadogMetricExportInfoWithDefaults added in v0.4.3 

func NewDatadogMetricExportInfoWithDefaults() *DatadogMetricExportInfo

NewDatadogMetricExportInfoWithDefaults instantiates a new DatadogMetricExportInfo object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DatadogMetricExportInfo) GetApiKey added in v0.4.3 

func (o *DatadogMetricExportInfo) GetApiKey() string

GetApiKey returns the ApiKey field value if set, zero value otherwise.

func (*DatadogMetricExportInfo) GetClusterId added in v0.4.3 

func (o *DatadogMetricExportInfo) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*DatadogMetricExportInfo) GetSite added in v0.4.3 

func (o *DatadogMetricExportInfo) GetSite() DatadogSiteType

GetSite returns the Site field value.

func (*DatadogMetricExportInfo) GetStatus added in v0.4.3 

func (o *DatadogMetricExportInfo) GetStatus() MetricExportStatusType

GetStatus returns the Status field value if set, zero value otherwise.

func (*DatadogMetricExportInfo) GetUserMessage added in v0.4.3 

func (o *DatadogMetricExportInfo) GetUserMessage() string

GetUserMessage returns the UserMessage field value if set, zero value otherwise.

func (*DatadogMetricExportInfo) SetApiKey added in v0.4.3 

func (o *DatadogMetricExportInfo) SetApiKey(v string)

SetApiKey gets a reference to the given string and assigns it to the ApiKey field.

func (*DatadogMetricExportInfo) SetClusterId added in v0.4.3 

func (o *DatadogMetricExportInfo) SetClusterId(v string)

SetClusterId sets field value.

func (*DatadogMetricExportInfo) SetSite added in v0.4.3 

func (o *DatadogMetricExportInfo) SetSite(v DatadogSiteType)

SetSite sets field value.

func (*DatadogMetricExportInfo) SetStatus added in v0.4.3 

func (o *DatadogMetricExportInfo) SetStatus(v MetricExportStatusType)

SetStatus gets a reference to the given MetricExportStatusType and assigns it to the Status field.

func (*DatadogMetricExportInfo) SetUserMessage added in v0.4.3 

func (o *DatadogMetricExportInfo) SetUserMessage(v string)

SetUserMessage gets a reference to the given string and assigns it to the UserMessage field.

type DatadogSiteType added in v1.0.0 

type DatadogSiteType string

DatadogSiteType the model 'DatadogSiteType'. 

const (
	DATADOGSITETYPE_US1     DatadogSiteType = "US1"
	DATADOGSITETYPE_US3     DatadogSiteType = "US3"
	DATADOGSITETYPE_US5     DatadogSiteType = "US5"
	DATADOGSITETYPE_US1_GOV DatadogSiteType = "US1_GOV"
	DATADOGSITETYPE_EU1     DatadogSiteType = "EU1"
)

List of DatadogSite.Type.

func NewDatadogSiteTypeFromValue added in v1.0.0 

func NewDatadogSiteTypeFromValue(v string) (*DatadogSiteType, error)

NewDatadogSiteTypeFromValue returns a pointer to a valid DatadogSiteType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (DatadogSiteType) IsValid added in v1.0.0 

func (v DatadogSiteType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (DatadogSiteType) Ptr added in v1.0.0 

func (v DatadogSiteType) Ptr() *DatadogSiteType

Ptr returns reference to DatadogSite.Type value.

type DedicatedClusterCreateSpecification 

type DedicatedClusterCreateSpecification struct {
	// The CockroachDB version for the cluster. The current version is used if omitted.
	CockroachVersion  *string                              `json:"cockroach_version,omitempty"`
	Hardware          DedicatedHardwareCreateSpecification `json:"hardware"`
	NetworkVisibility *NetworkVisibilityType               `json:"network_visibility,omitempty"`
	// Region keys should match the cloud provider's zone code. For example, for Oregon, set region_name to \"us-west2\" for GCP and \"us-west-2\" for AWS. Values represent the node count.
	RegionNodes map[string]int32 `json:"region_nodes"`
	// Preview: RestrictEgressTraffic if set, results in an egress traffic policy of default-deny at creation time.
	RestrictEgressTraffic *bool `json:"restrict_egress_traffic,omitempty"`
}

DedicatedClusterCreateSpecification struct for DedicatedClusterCreateSpecification.

func NewDedicatedClusterCreateSpecification 

func NewDedicatedClusterCreateSpecification(hardware DedicatedHardwareCreateSpecification, regionNodes map[string]int32) *DedicatedClusterCreateSpecification

NewDedicatedClusterCreateSpecification instantiates a new DedicatedClusterCreateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDedicatedClusterCreateSpecificationWithDefaults 

func NewDedicatedClusterCreateSpecificationWithDefaults() *DedicatedClusterCreateSpecification

NewDedicatedClusterCreateSpecificationWithDefaults instantiates a new DedicatedClusterCreateSpecification object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DedicatedClusterCreateSpecification) GetCockroachVersion 

func (o *DedicatedClusterCreateSpecification) GetCockroachVersion() string

GetCockroachVersion returns the CockroachVersion field value if set, zero value otherwise.

func (*DedicatedClusterCreateSpecification) GetHardware 

func (o *DedicatedClusterCreateSpecification) GetHardware() DedicatedHardwareCreateSpecification

GetHardware returns the Hardware field value.

func (*DedicatedClusterCreateSpecification) GetNetworkVisibility added in v0.3.3 

func (o *DedicatedClusterCreateSpecification) GetNetworkVisibility() NetworkVisibilityType

GetNetworkVisibility returns the NetworkVisibility field value if set, zero value otherwise.

func (*DedicatedClusterCreateSpecification) GetRegionNodes 

func (o *DedicatedClusterCreateSpecification) GetRegionNodes() map[string]int32

GetRegionNodes returns the RegionNodes field value.

func (*DedicatedClusterCreateSpecification) GetRestrictEgressTraffic added in v0.3.4 

func (o *DedicatedClusterCreateSpecification) GetRestrictEgressTraffic() bool

GetRestrictEgressTraffic returns the RestrictEgressTraffic field value if set, zero value otherwise.

func (*DedicatedClusterCreateSpecification) SetCockroachVersion 

func (o *DedicatedClusterCreateSpecification) SetCockroachVersion(v string)

SetCockroachVersion gets a reference to the given string and assigns it to the CockroachVersion field.

func (*DedicatedClusterCreateSpecification) SetHardware 

func (o *DedicatedClusterCreateSpecification) SetHardware(v DedicatedHardwareCreateSpecification)

SetHardware sets field value.

func (*DedicatedClusterCreateSpecification) SetNetworkVisibility added in v0.3.3 

func (o *DedicatedClusterCreateSpecification) SetNetworkVisibility(v NetworkVisibilityType)

SetNetworkVisibility gets a reference to the given NetworkVisibilityType and assigns it to the NetworkVisibility field.

func (*DedicatedClusterCreateSpecification) SetRegionNodes 

func (o *DedicatedClusterCreateSpecification) SetRegionNodes(v map[string]int32)

SetRegionNodes sets field value.

func (*DedicatedClusterCreateSpecification) SetRestrictEgressTraffic added in v0.3.4 

func (o *DedicatedClusterCreateSpecification) SetRestrictEgressTraffic(v bool)

SetRestrictEgressTraffic gets a reference to the given bool and assigns it to the RestrictEgressTraffic field.

type DedicatedClusterUpdateSpecification 

type DedicatedClusterUpdateSpecification struct {
	// This field should contain the CMEK specs for newly added regions. If a CMEK spec is provided for an existing region, the request is invalid and will fail.
	CmekRegionSpecs *[]CMEKRegionSpecification            `json:"cmek_region_specs,omitempty"`
	Hardware        *DedicatedHardwareUpdateSpecification `json:"hardware,omitempty"`
	// Region keys should match the cloud provider's zone code. For example, for Oregon, set region_name to \"us-west2\" for GCP and \"us-west-2\" for AWS. Values represent the node count.
	RegionNodes *map[string]int32 `json:"region_nodes,omitempty"`
}

DedicatedClusterUpdateSpecification struct for DedicatedClusterUpdateSpecification.

func NewDedicatedClusterUpdateSpecification 

func NewDedicatedClusterUpdateSpecification() *DedicatedClusterUpdateSpecification

NewDedicatedClusterUpdateSpecification instantiates a new DedicatedClusterUpdateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*DedicatedClusterUpdateSpecification) GetCmekRegionSpecs 

func (o *DedicatedClusterUpdateSpecification) GetCmekRegionSpecs() []CMEKRegionSpecification

GetCmekRegionSpecs returns the CmekRegionSpecs field value if set, zero value otherwise.

func (*DedicatedClusterUpdateSpecification) GetHardware 

func (o *DedicatedClusterUpdateSpecification) GetHardware() DedicatedHardwareUpdateSpecification

GetHardware returns the Hardware field value if set, zero value otherwise.

func (*DedicatedClusterUpdateSpecification) GetRegionNodes 

func (o *DedicatedClusterUpdateSpecification) GetRegionNodes() map[string]int32

GetRegionNodes returns the RegionNodes field value if set, zero value otherwise.

func (*DedicatedClusterUpdateSpecification) SetCmekRegionSpecs 

func (o *DedicatedClusterUpdateSpecification) SetCmekRegionSpecs(v []CMEKRegionSpecification)

SetCmekRegionSpecs gets a reference to the given []CMEKRegionSpecification and assigns it to the CmekRegionSpecs field.

func (*DedicatedClusterUpdateSpecification) SetHardware 

func (o *DedicatedClusterUpdateSpecification) SetHardware(v DedicatedHardwareUpdateSpecification)

SetHardware gets a reference to the given DedicatedHardwareUpdateSpecification and assigns it to the Hardware field.

func (*DedicatedClusterUpdateSpecification) SetRegionNodes 

func (o *DedicatedClusterUpdateSpecification) SetRegionNodes(v map[string]int32)

SetRegionNodes gets a reference to the given map[string]int32 and assigns it to the RegionNodes field.

type DedicatedHardwareConfig 

type DedicatedHardwareConfig struct {
	// disk_iops is the number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
	DiskIops int32 `json:"disk_iops"`
	// machine_type is the machine type identifier within the given cloud provider, ex. m5.xlarge, n2-standard-4.
	MachineType string `json:"machine_type"`
	// memory_gib is the memory GiB per node in the cluster.
	MemoryGib float32 `json:"memory_gib"`
	// num_virtual_cpus is the number of virtual CPUs per node in the cluster.
	NumVirtualCpus int32 `json:"num_virtual_cpus"`
	// storage_gib is the number of storage GiB per node in the cluster.
	StorageGib int32 `json:"storage_gib"`
}

DedicatedHardwareConfig struct for DedicatedHardwareConfig.

func NewDedicatedHardwareConfig 

func NewDedicatedHardwareConfig(diskIops int32, machineType string, memoryGib float32, numVirtualCpus int32, storageGib int32) *DedicatedHardwareConfig

NewDedicatedHardwareConfig instantiates a new DedicatedHardwareConfig object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDedicatedHardwareConfigWithDefaults 

func NewDedicatedHardwareConfigWithDefaults() *DedicatedHardwareConfig

NewDedicatedHardwareConfigWithDefaults instantiates a new DedicatedHardwareConfig object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DedicatedHardwareConfig) GetDiskIops 

func (o *DedicatedHardwareConfig) GetDiskIops() int32

GetDiskIops returns the DiskIops field value.

func (*DedicatedHardwareConfig) GetMachineType 

func (o *DedicatedHardwareConfig) GetMachineType() string

GetMachineType returns the MachineType field value.

func (*DedicatedHardwareConfig) GetMemoryGib 

func (o *DedicatedHardwareConfig) GetMemoryGib() float32

GetMemoryGib returns the MemoryGib field value.

func (*DedicatedHardwareConfig) GetNumVirtualCpus 

func (o *DedicatedHardwareConfig) GetNumVirtualCpus() int32

GetNumVirtualCpus returns the NumVirtualCpus field value.

func (*DedicatedHardwareConfig) GetStorageGib 

func (o *DedicatedHardwareConfig) GetStorageGib() int32

GetStorageGib returns the StorageGib field value.

func (*DedicatedHardwareConfig) SetDiskIops 

func (o *DedicatedHardwareConfig) SetDiskIops(v int32)

SetDiskIops sets field value.

func (*DedicatedHardwareConfig) SetMachineType 

func (o *DedicatedHardwareConfig) SetMachineType(v string)

SetMachineType sets field value.

func (*DedicatedHardwareConfig) SetMemoryGib 

func (o *DedicatedHardwareConfig) SetMemoryGib(v float32)

SetMemoryGib sets field value.

func (*DedicatedHardwareConfig) SetNumVirtualCpus 

func (o *DedicatedHardwareConfig) SetNumVirtualCpus(v int32)

SetNumVirtualCpus sets field value.

func (*DedicatedHardwareConfig) SetStorageGib 

func (o *DedicatedHardwareConfig) SetStorageGib(v int32)

SetStorageGib sets field value.

type DedicatedHardwareCreateSpecification 

type DedicatedHardwareCreateSpecification struct {
	// disk_iops is the number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default. Only available for AWS clusters.
	DiskIops    *int32                            `json:"disk_iops,omitempty"`
	MachineSpec DedicatedMachineTypeSpecification `json:"machine_spec"`
	// storage_gib is the number of storage GiB per node in the cluster. Zero indicates default to the lowest storage GiB available given machine specs.
	StorageGib int32 `json:"storage_gib"`
}

DedicatedHardwareCreateSpecification struct for DedicatedHardwareCreateSpecification.

func NewDedicatedHardwareCreateSpecification 

func NewDedicatedHardwareCreateSpecification(machineSpec DedicatedMachineTypeSpecification, storageGib int32) *DedicatedHardwareCreateSpecification

NewDedicatedHardwareCreateSpecification instantiates a new DedicatedHardwareCreateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDedicatedHardwareCreateSpecificationWithDefaults 

func NewDedicatedHardwareCreateSpecificationWithDefaults() *DedicatedHardwareCreateSpecification

NewDedicatedHardwareCreateSpecificationWithDefaults instantiates a new DedicatedHardwareCreateSpecification object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DedicatedHardwareCreateSpecification) GetDiskIops 

func (o *DedicatedHardwareCreateSpecification) GetDiskIops() int32

GetDiskIops returns the DiskIops field value if set, zero value otherwise.

func (*DedicatedHardwareCreateSpecification) GetMachineSpec 

func (o *DedicatedHardwareCreateSpecification) GetMachineSpec() DedicatedMachineTypeSpecification

GetMachineSpec returns the MachineSpec field value.

func (*DedicatedHardwareCreateSpecification) GetStorageGib 

func (o *DedicatedHardwareCreateSpecification) GetStorageGib() int32

GetStorageGib returns the StorageGib field value.

func (*DedicatedHardwareCreateSpecification) SetDiskIops 

func (o *DedicatedHardwareCreateSpecification) SetDiskIops(v int32)

SetDiskIops gets a reference to the given int32 and assigns it to the DiskIops field.

func (*DedicatedHardwareCreateSpecification) SetMachineSpec 

func (o *DedicatedHardwareCreateSpecification) SetMachineSpec(v DedicatedMachineTypeSpecification)

SetMachineSpec sets field value.

func (*DedicatedHardwareCreateSpecification) SetStorageGib 

func (o *DedicatedHardwareCreateSpecification) SetStorageGib(v int32)

SetStorageGib sets field value.

type DedicatedHardwareUpdateSpecification 

type DedicatedHardwareUpdateSpecification struct {
	// disk_iops is the number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default. Only available for AWS clusters.
	DiskIops    *int32                             `json:"disk_iops,omitempty"`
	MachineSpec *DedicatedMachineTypeSpecification `json:"machine_spec,omitempty"`
	// storage_gib is the number of storage GiB per node in the cluster.
	StorageGib *int32 `json:"storage_gib,omitempty"`
}

DedicatedHardwareUpdateSpecification struct for DedicatedHardwareUpdateSpecification.

func NewDedicatedHardwareUpdateSpecification 

func NewDedicatedHardwareUpdateSpecification() *DedicatedHardwareUpdateSpecification

NewDedicatedHardwareUpdateSpecification instantiates a new DedicatedHardwareUpdateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*DedicatedHardwareUpdateSpecification) GetDiskIops 

func (o *DedicatedHardwareUpdateSpecification) GetDiskIops() int32

GetDiskIops returns the DiskIops field value if set, zero value otherwise.

func (*DedicatedHardwareUpdateSpecification) GetMachineSpec 

func (o *DedicatedHardwareUpdateSpecification) GetMachineSpec() DedicatedMachineTypeSpecification

GetMachineSpec returns the MachineSpec field value if set, zero value otherwise.

func (*DedicatedHardwareUpdateSpecification) GetStorageGib 

func (o *DedicatedHardwareUpdateSpecification) GetStorageGib() int32

GetStorageGib returns the StorageGib field value if set, zero value otherwise.

func (*DedicatedHardwareUpdateSpecification) SetDiskIops 

func (o *DedicatedHardwareUpdateSpecification) SetDiskIops(v int32)

SetDiskIops gets a reference to the given int32 and assigns it to the DiskIops field.

func (*DedicatedHardwareUpdateSpecification) SetMachineSpec 

func (o *DedicatedHardwareUpdateSpecification) SetMachineSpec(v DedicatedMachineTypeSpecification)

SetMachineSpec gets a reference to the given DedicatedMachineTypeSpecification and assigns it to the MachineSpec field.

func (*DedicatedHardwareUpdateSpecification) SetStorageGib 

func (o *DedicatedHardwareUpdateSpecification) SetStorageGib(v int32)

SetStorageGib gets a reference to the given int32 and assigns it to the StorageGib field.

type DedicatedMachineTypeSpecification 

type DedicatedMachineTypeSpecification struct {
	// machine_type is the machine type identifier within the given cloud provider, ex. m5.xlarge, n2-standard-4.
	MachineType *string `json:"machine_type,omitempty"`
	// num_virtual_cpus may be used to automatically select a machine type according to the desired number of vCPUs.
	NumVirtualCpus *int32 `json:"num_virtual_cpus,omitempty"`
}

DedicatedMachineTypeSpecification struct for DedicatedMachineTypeSpecification.

func NewDedicatedMachineTypeSpecification 

func NewDedicatedMachineTypeSpecification() *DedicatedMachineTypeSpecification

NewDedicatedMachineTypeSpecification instantiates a new DedicatedMachineTypeSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*DedicatedMachineTypeSpecification) GetMachineType 

func (o *DedicatedMachineTypeSpecification) GetMachineType() string

GetMachineType returns the MachineType field value if set, zero value otherwise.

func (*DedicatedMachineTypeSpecification) GetNumVirtualCpus 

func (o *DedicatedMachineTypeSpecification) GetNumVirtualCpus() int32

GetNumVirtualCpus returns the NumVirtualCpus field value if set, zero value otherwise.

func (*DedicatedMachineTypeSpecification) SetMachineType 

func (o *DedicatedMachineTypeSpecification) SetMachineType(v string)

SetMachineType gets a reference to the given string and assigns it to the MachineType field.

func (*DedicatedMachineTypeSpecification) SetNumVirtualCpus 

func (o *DedicatedMachineTypeSpecification) SetNumVirtualCpus(v int32)

SetNumVirtualCpus gets a reference to the given int32 and assigns it to the NumVirtualCpus field.

type DeleteEgressRuleOptions added in v0.3.3 

type DeleteEgressRuleOptions struct {
	// idempotency_key uniquely identifies this request. If not set, it will be set by the server.
	IdempotencyKey *string
}

DeleteEgressRuleOptions contains optional parameters for DeleteEgressRule.

type DeleteEgressRuleResponse added in v0.3.3 

type DeleteEgressRuleResponse struct {
	Rule *EgressRule `json:"Rule,omitempty"`
}

DeleteEgressRuleResponse DeleteEgressRuleResponse is the output for the DeleteEgressRule RPC..

func NewDeleteEgressRuleResponse added in v0.3.3 

func NewDeleteEgressRuleResponse() *DeleteEgressRuleResponse

NewDeleteEgressRuleResponse instantiates a new DeleteEgressRuleResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*DeleteEgressRuleResponse) GetRule added in v0.3.3 

func (o *DeleteEgressRuleResponse) GetRule() EgressRule

GetRule returns the Rule field value if set, zero value otherwise.

func (*DeleteEgressRuleResponse) SetRule added in v0.3.3 

func (o *DeleteEgressRuleResponse) SetRule(v EgressRule)

SetRule gets a reference to the given EgressRule and assigns it to the Rule field.

type DeleteMetricExportResponse added in v0.3.3 

type DeleteMetricExportResponse struct {
	ClusterId string                  `json:"cluster_id"`
	Status    *MetricExportStatusType `json:"status,omitempty"`
}

DeleteMetricExportResponse struct for DeleteMetricExportResponse.

func NewDeleteMetricExportResponse added in v0.3.3 

func NewDeleteMetricExportResponse(clusterId string) *DeleteMetricExportResponse

NewDeleteMetricExportResponse instantiates a new DeleteMetricExportResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeleteMetricExportResponseWithDefaults added in v0.4.3 

func NewDeleteMetricExportResponseWithDefaults() *DeleteMetricExportResponse

NewDeleteMetricExportResponseWithDefaults instantiates a new DeleteMetricExportResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeleteMetricExportResponse) GetClusterId added in v0.3.3 

func (o *DeleteMetricExportResponse) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*DeleteMetricExportResponse) GetStatus added in v0.3.3 

func (o *DeleteMetricExportResponse) GetStatus() MetricExportStatusType

GetStatus returns the Status field value if set, zero value otherwise.

func (*DeleteMetricExportResponse) SetClusterId added in v0.3.3 

func (o *DeleteMetricExportResponse) SetClusterId(v string)

SetClusterId sets field value.

func (*DeleteMetricExportResponse) SetStatus added in v0.3.3 

func (o *DeleteMetricExportResponse) SetStatus(v MetricExportStatusType)

SetStatus gets a reference to the given MetricExportStatusType and assigns it to the Status field.

type DeleteProtectionStateType added in v1.10.0 

type DeleteProtectionStateType string

DeleteProtectionStateType the model 'DeleteProtectionStateType'. 

const (
	DELETEPROTECTIONSTATETYPE_ENABLED  DeleteProtectionStateType = "ENABLED"
	DELETEPROTECTIONSTATETYPE_DISABLED DeleteProtectionStateType = "DISABLED"
)

List of DeleteProtectionState.Type.

func NewDeleteProtectionStateTypeFromValue added in v1.10.0 

func NewDeleteProtectionStateTypeFromValue(v string) (*DeleteProtectionStateType, error)

NewDeleteProtectionStateTypeFromValue returns a pointer to a valid DeleteProtectionStateType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (DeleteProtectionStateType) IsValid added in v1.10.0 

func (v DeleteProtectionStateType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (DeleteProtectionStateType) Ptr added in v1.10.0 

func (v DeleteProtectionStateType) Ptr() *DeleteProtectionStateType

Ptr returns reference to DeleteProtectionState.Type value.

type EditEgressRuleRequest added in v0.3.3 

type EditEgressRuleRequest struct {
	// description is text that serves to document the rules purpose.
	Description *string `json:"description,omitempty"`
	// destination is a CIDR range or fully-qualified domain name to which outgoing traffic should be allowed. This field is required.
	Destination *string `json:"destination,omitempty"`
	// idempotency_key uniquely identifies this request. If not set, it will be set by the server.
	IdempotencyKey *string `json:"idempotency_key,omitempty"`
	// Deprecated: This field is ignored and will be removed in the next version. paths are the allowed URL paths. If empty, all paths are allowed. Only valid if Type=\"FQDN\".
	Paths *[]string `json:"paths,omitempty"`
	// ports are the allowed ports for TCP protocol. If empty, all ports are allowed.
	Ports *[]int32 `json:"ports,omitempty"`
	// type is the destination type of this rule. Example values are FQDN or CIDR. This field is required.
	Type *string `json:"type,omitempty"`
}

EditEgressRuleRequest EditEgressRuleRequest is the input message to the EditEgressRule RPC..

func NewEditEgressRuleRequest added in v0.3.3 

func NewEditEgressRuleRequest() *EditEgressRuleRequest

NewEditEgressRuleRequest instantiates a new EditEgressRuleRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*EditEgressRuleRequest) GetDescription added in v0.3.3 

func (o *EditEgressRuleRequest) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*EditEgressRuleRequest) GetDestination added in v0.3.3 

func (o *EditEgressRuleRequest) GetDestination() string

GetDestination returns the Destination field value if set, zero value otherwise.

func (*EditEgressRuleRequest) GetIdempotencyKey added in v0.3.3 

func (o *EditEgressRuleRequest) GetIdempotencyKey() string

GetIdempotencyKey returns the IdempotencyKey field value if set, zero value otherwise.

func (*EditEgressRuleRequest) GetPaths added in v0.3.3 

func (o *EditEgressRuleRequest) GetPaths() []string

GetPaths returns the Paths field value if set, zero value otherwise.

func (*EditEgressRuleRequest) GetPorts added in v0.3.3 

func (o *EditEgressRuleRequest) GetPorts() []int32

GetPorts returns the Ports field value if set, zero value otherwise.

func (*EditEgressRuleRequest) GetType added in v0.3.3 

func (o *EditEgressRuleRequest) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*EditEgressRuleRequest) SetDescription added in v0.3.3 

func (o *EditEgressRuleRequest) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*EditEgressRuleRequest) SetDestination added in v0.3.3 

func (o *EditEgressRuleRequest) SetDestination(v string)

SetDestination gets a reference to the given string and assigns it to the Destination field.

func (*EditEgressRuleRequest) SetIdempotencyKey added in v0.3.3 

func (o *EditEgressRuleRequest) SetIdempotencyKey(v string)

SetIdempotencyKey gets a reference to the given string and assigns it to the IdempotencyKey field.

func (*EditEgressRuleRequest) SetPaths added in v0.3.3 

func (o *EditEgressRuleRequest) SetPaths(v []string)

SetPaths gets a reference to the given []string and assigns it to the Paths field.

func (*EditEgressRuleRequest) SetPorts added in v0.3.3 

func (o *EditEgressRuleRequest) SetPorts(v []int32)

SetPorts gets a reference to the given []int32 and assigns it to the Ports field.

func (*EditEgressRuleRequest) SetType added in v0.3.3 

func (o *EditEgressRuleRequest) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

type EditEgressRuleResponse added in v0.3.3 

type EditEgressRuleResponse struct {
	Rule *EgressRule `json:"Rule,omitempty"`
}

EditEgressRuleResponse EditEgressRuleResponse is the output message to the EditEgressRule RPC..

func NewEditEgressRuleResponse added in v0.3.3 

func NewEditEgressRuleResponse() *EditEgressRuleResponse

NewEditEgressRuleResponse instantiates a new EditEgressRuleResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*EditEgressRuleResponse) GetRule added in v0.3.3 

func (o *EditEgressRuleResponse) GetRule() EgressRule

GetRule returns the Rule field value if set, zero value otherwise.

func (*EditEgressRuleResponse) SetRule added in v0.3.3 

func (o *EditEgressRuleResponse) SetRule(v EgressRule)

SetRule gets a reference to the given EgressRule and assigns it to the Rule field.

type EgressRule added in v0.3.3 

type EgressRule struct {
	// cluster_id identifies the cluster to which this egress rule applies.
	ClusterId string `json:"cluster_id"`
	// created_at is the time at which the time at which the egress rule was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// crl_managed indicates this egress rule is managed by CockroachDB Cloud services. This field is set by the server.
	CrlManaged bool `json:"crl_managed"`
	// description is a longer that serves to document the rules purpose.
	Description string `json:"description"`
	// destination is the endpoint (or subnetwork if CIDR) to which traffic is allowed.
	Destination string `json:"destination"`
	// id uniquely identifies this egress rule.
	Id string `json:"id"`
	// name is the name of the egress rule.
	Name string `json:"name"`
	// Deprecated: This field is ignored and will be removed in the next version. paths are the allowed URL paths. Only valid if Type=\"FQDN\".
	Paths *[]string `json:"paths,omitempty"`
	// ports are the allowed ports for TCP protocol. If Empty, all ports are allowed.
	Ports *[]int32 `json:"ports,omitempty"`
	// state indicates the state of the egress rule.
	State string `json:"state"`
	// type classifies the destination field. Valid types include: \"FQDN\", \"CIDR\".
	Type string `json:"type"`
}

EgressRule EgressRule represents a network egress rule..

func NewEgressRule added in v0.3.3 

func NewEgressRule(clusterId string, crlManaged bool, description string, destination string, id string, name string, state string, type_ string) *EgressRule

NewEgressRule instantiates a new EgressRule object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEgressRuleWithDefaults added in v0.3.3 

func NewEgressRuleWithDefaults() *EgressRule

NewEgressRuleWithDefaults instantiates a new EgressRule object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EgressRule) GetClusterId added in v0.3.3 

func (o *EgressRule) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*EgressRule) GetCreatedAt added in v0.3.3 

func (o *EgressRule) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*EgressRule) GetCrlManaged added in v0.3.3 

func (o *EgressRule) GetCrlManaged() bool

GetCrlManaged returns the CrlManaged field value.

func (*EgressRule) GetDescription added in v0.3.3 

func (o *EgressRule) GetDescription() string

GetDescription returns the Description field value.

func (*EgressRule) GetDestination added in v0.3.3 

func (o *EgressRule) GetDestination() string

GetDestination returns the Destination field value.

func (*EgressRule) GetId added in v0.3.3 

func (o *EgressRule) GetId() string

GetId returns the Id field value.

func (*EgressRule) GetName added in v0.3.3 

func (o *EgressRule) GetName() string

GetName returns the Name field value.

func (*EgressRule) GetPaths added in v0.3.3 

func (o *EgressRule) GetPaths() []string

GetPaths returns the Paths field value if set, zero value otherwise.

func (*EgressRule) GetPorts added in v0.3.3 

func (o *EgressRule) GetPorts() []int32

GetPorts returns the Ports field value if set, zero value otherwise.

func (*EgressRule) GetState added in v0.3.3 

func (o *EgressRule) GetState() string

GetState returns the State field value.

func (*EgressRule) GetType added in v0.3.3 

func (o *EgressRule) GetType() string

GetType returns the Type field value.

func (*EgressRule) SetClusterId added in v0.3.3 

func (o *EgressRule) SetClusterId(v string)

SetClusterId sets field value.

func (*EgressRule) SetCreatedAt added in v0.3.3 

func (o *EgressRule) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*EgressRule) SetCrlManaged added in v0.3.3 

func (o *EgressRule) SetCrlManaged(v bool)

SetCrlManaged sets field value.

func (*EgressRule) SetDescription added in v0.3.3 

func (o *EgressRule) SetDescription(v string)

SetDescription sets field value.

func (*EgressRule) SetDestination added in v0.3.3 

func (o *EgressRule) SetDestination(v string)

SetDestination sets field value.

func (*EgressRule) SetId added in v0.3.3 

func (o *EgressRule) SetId(v string)

SetId sets field value.

func (*EgressRule) SetName added in v0.3.3 

func (o *EgressRule) SetName(v string)

SetName sets field value.

func (*EgressRule) SetPaths added in v0.3.3 

func (o *EgressRule) SetPaths(v []string)

SetPaths gets a reference to the given []string and assigns it to the Paths field.

func (*EgressRule) SetPorts added in v0.3.3 

func (o *EgressRule) SetPorts(v []int32)

SetPorts gets a reference to the given []int32 and assigns it to the Ports field.

func (*EgressRule) SetState added in v0.3.3 

func (o *EgressRule) SetState(v string)

SetState sets field value.

func (*EgressRule) SetType added in v0.3.3 

func (o *EgressRule) SetType(v string)

SetType sets field value.

type EgressTrafficPolicyType added in v1.0.0 

type EgressTrafficPolicyType string

EgressTrafficPolicyType - UNSPECIFIED: UNSPECIFIED signifies the egress traffic policy is unspecified. - ERROR: ERROR signifies there has been an internal server error during an update to the egress traffic policy. - ALLOW_ALL: ALLOW_ALL signifies all outbound connections from CockroachDB are allowed. - DEFAULT_DENY: DEFAULT_DENY signifies that CockroachDB can only initiate network connections to destinations explicitly allowed by the user or CockroachDB Cloud operators. - UPDATING: UPDATING signifies the egress traffic policy is updating. 

const (
	EGRESSTRAFFICPOLICYTYPE_UNSPECIFIED  EgressTrafficPolicyType = "UNSPECIFIED"
	EGRESSTRAFFICPOLICYTYPE_ERROR        EgressTrafficPolicyType = "ERROR"
	EGRESSTRAFFICPOLICYTYPE_ALLOW_ALL    EgressTrafficPolicyType = "ALLOW_ALL"
	EGRESSTRAFFICPOLICYTYPE_DEFAULT_DENY EgressTrafficPolicyType = "DEFAULT_DENY"
	EGRESSTRAFFICPOLICYTYPE_UPDATING     EgressTrafficPolicyType = "UPDATING"
)

List of EgressTrafficPolicy.Type.

func NewEgressTrafficPolicyTypeFromValue added in v1.0.0 

func NewEgressTrafficPolicyTypeFromValue(v string) (*EgressTrafficPolicyType, error)

NewEgressTrafficPolicyTypeFromValue returns a pointer to a valid EgressTrafficPolicyType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (EgressTrafficPolicyType) IsValid added in v1.0.0 

func (v EgressTrafficPolicyType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (EgressTrafficPolicyType) Ptr added in v1.0.0 

func (v EgressTrafficPolicyType) Ptr() *EgressTrafficPolicyType

Ptr returns reference to EgressTrafficPolicy.Type value.

type EnableCloudWatchMetricExportRequest added in v0.4.3 

type EnableCloudWatchMetricExportRequest struct {
	// log_group_name is the customized log group name.
	LogGroupName *string `json:"log_group_name,omitempty"`
	// role_arn is the IAM role used to upload metric segments to the target AWS account.
	RoleArn string `json:"role_arn"`
	// target_region specifies the specific AWS region that the metrics will be exported to.
	TargetRegion *string `json:"target_region,omitempty"`
}

EnableCloudWatchMetricExportRequest struct for EnableCloudWatchMetricExportRequest.

func NewEnableCloudWatchMetricExportRequest added in v0.4.3 

func NewEnableCloudWatchMetricExportRequest(roleArn string) *EnableCloudWatchMetricExportRequest

NewEnableCloudWatchMetricExportRequest instantiates a new EnableCloudWatchMetricExportRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEnableCloudWatchMetricExportRequestWithDefaults added in v0.4.3 

func NewEnableCloudWatchMetricExportRequestWithDefaults() *EnableCloudWatchMetricExportRequest

NewEnableCloudWatchMetricExportRequestWithDefaults instantiates a new EnableCloudWatchMetricExportRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EnableCloudWatchMetricExportRequest) GetLogGroupName added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) GetLogGroupName() string

GetLogGroupName returns the LogGroupName field value if set, zero value otherwise.

func (*EnableCloudWatchMetricExportRequest) GetRoleArn added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) GetRoleArn() string

GetRoleArn returns the RoleArn field value.

func (*EnableCloudWatchMetricExportRequest) GetTargetRegion added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) GetTargetRegion() string

GetTargetRegion returns the TargetRegion field value if set, zero value otherwise.

func (*EnableCloudWatchMetricExportRequest) SetLogGroupName added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) SetLogGroupName(v string)

SetLogGroupName gets a reference to the given string and assigns it to the LogGroupName field.

func (*EnableCloudWatchMetricExportRequest) SetRoleArn added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) SetRoleArn(v string)

SetRoleArn sets field value.

func (*EnableCloudWatchMetricExportRequest) SetTargetRegion added in v0.4.3 

func (o *EnableCloudWatchMetricExportRequest) SetTargetRegion(v string)

SetTargetRegion gets a reference to the given string and assigns it to the TargetRegion field.

type EnableDatadogMetricExportRequest added in v0.4.3 

type EnableDatadogMetricExportRequest struct {
	// api_key is a Datadog API key.
	ApiKey string          `json:"api_key"`
	Site   DatadogSiteType `json:"site"`
}

EnableDatadogMetricExportRequest struct for EnableDatadogMetricExportRequest.

func NewEnableDatadogMetricExportRequest added in v0.4.3 

func NewEnableDatadogMetricExportRequest(apiKey string, site DatadogSiteType) *EnableDatadogMetricExportRequest

NewEnableDatadogMetricExportRequest instantiates a new EnableDatadogMetricExportRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEnableDatadogMetricExportRequestWithDefaults added in v0.4.3 

func NewEnableDatadogMetricExportRequestWithDefaults() *EnableDatadogMetricExportRequest

NewEnableDatadogMetricExportRequestWithDefaults instantiates a new EnableDatadogMetricExportRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EnableDatadogMetricExportRequest) GetApiKey added in v0.4.3 

func (o *EnableDatadogMetricExportRequest) GetApiKey() string

GetApiKey returns the ApiKey field value.

func (*EnableDatadogMetricExportRequest) GetSite added in v0.4.3 

func (o *EnableDatadogMetricExportRequest) GetSite() DatadogSiteType

GetSite returns the Site field value.

func (*EnableDatadogMetricExportRequest) SetApiKey added in v0.4.3 

func (o *EnableDatadogMetricExportRequest) SetApiKey(v string)

SetApiKey sets field value.

func (*EnableDatadogMetricExportRequest) SetSite added in v0.4.3 

func (o *EnableDatadogMetricExportRequest) SetSite(v DatadogSiteType)

SetSite sets field value.

type EnableLogExportRequest 

type EnableLogExportRequest struct {
	// auth_principal is either the AWS Role ARN that identifies a role that the cluster account can assume to write to CloudWatch or the GCP Project ID that the cluster service account has permissions to write to for cloud logging.
	AuthPrincipal string `json:"auth_principal"`
	// groups is a collection of log group configurations that allows the customer to define collections of CRDB log channels that are aggregated separately at the target sink.
	Groups *[]LogExportGroup `json:"groups,omitempty"`
	// log_name is an identifier for the logs in the customer's log sink.
	LogName string `json:"log_name"`
	// omitted_channels is a list of channels that the user does not want to export logs for.
	OmittedChannels *[]string `json:"omitted_channels,omitempty"`
	// redact allows the customer to set a default redaction policy for logs before they are exported to the target sink. If a group config omits a redact flag and this one is set to `true`, then that group will receive redacted logs.
	Redact *bool `json:"redact,omitempty"`
	// region allows the customer to override the destination region for all logs for a cluster.
	Region *string       `json:"region,omitempty"`
	Type   LogExportType `json:"type"`
}

EnableLogExportRequest struct for EnableLogExportRequest.

func NewEnableLogExportRequest 

func NewEnableLogExportRequest(authPrincipal string, logName string, type_ LogExportType) *EnableLogExportRequest

NewEnableLogExportRequest instantiates a new EnableLogExportRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEnableLogExportRequestWithDefaults added in v0.4.0 

func NewEnableLogExportRequestWithDefaults() *EnableLogExportRequest

NewEnableLogExportRequestWithDefaults instantiates a new EnableLogExportRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EnableLogExportRequest) GetAuthPrincipal 

func (o *EnableLogExportRequest) GetAuthPrincipal() string

GetAuthPrincipal returns the AuthPrincipal field value.

func (*EnableLogExportRequest) GetGroups added in v0.3.3 

func (o *EnableLogExportRequest) GetGroups() []LogExportGroup

GetGroups returns the Groups field value if set, zero value otherwise.

func (*EnableLogExportRequest) GetLogName 

func (o *EnableLogExportRequest) GetLogName() string

GetLogName returns the LogName field value.

func (*EnableLogExportRequest) GetOmittedChannels added in v1.4.0 

func (o *EnableLogExportRequest) GetOmittedChannels() []string

GetOmittedChannels returns the OmittedChannels field value if set, zero value otherwise.

func (*EnableLogExportRequest) GetRedact added in v0.3.3 

func (o *EnableLogExportRequest) GetRedact() bool

GetRedact returns the Redact field value if set, zero value otherwise.

func (*EnableLogExportRequest) GetRegion added in v0.3.3 

func (o *EnableLogExportRequest) GetRegion() string

GetRegion returns the Region field value if set, zero value otherwise.

func (*EnableLogExportRequest) GetType 

func (o *EnableLogExportRequest) GetType() LogExportType

GetType returns the Type field value.

func (*EnableLogExportRequest) SetAuthPrincipal 

func (o *EnableLogExportRequest) SetAuthPrincipal(v string)

SetAuthPrincipal sets field value.

func (*EnableLogExportRequest) SetGroups added in v0.3.3 

func (o *EnableLogExportRequest) SetGroups(v []LogExportGroup)

SetGroups gets a reference to the given []LogExportGroup and assigns it to the Groups field.

func (*EnableLogExportRequest) SetLogName 

func (o *EnableLogExportRequest) SetLogName(v string)

SetLogName sets field value.

func (*EnableLogExportRequest) SetOmittedChannels added in v1.4.0 

func (o *EnableLogExportRequest) SetOmittedChannels(v []string)

SetOmittedChannels gets a reference to the given []string and assigns it to the OmittedChannels field.

func (*EnableLogExportRequest) SetRedact added in v0.3.3 

func (o *EnableLogExportRequest) SetRedact(v bool)

SetRedact gets a reference to the given bool and assigns it to the Redact field.

func (*EnableLogExportRequest) SetRegion added in v0.3.3 

func (o *EnableLogExportRequest) SetRegion(v string)

SetRegion gets a reference to the given string and assigns it to the Region field.

func (*EnableLogExportRequest) SetType 

func (o *EnableLogExportRequest) SetType(v LogExportType)

SetType sets field value.

type Error 

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

Error Provides access to the body, error and model on returned errors.

func (Error) Body 

func (e Error) Body() []byte

Body returns the raw bytes of the response.

func (Error) Error 

func (e Error) Error() string

Error returns non-empty string if there was an error.

func (Error) Model 

func (e Error) Model() interface{}

Model returns the unpacked model of the error.

type FolderResource added in v1.4.0 

type FolderResource struct {
	// name is the resource's name.
	Name string `json:"name"`
	// organization_id is the id of the organization this resource belongs to.
	OrganizationId string `json:"organization_id"`
	// parent_id is the id of the resource's parent folder. \"root\" represents a root level resource.
	ParentId string `json:"parent_id"`
	// path contains the ids and names of ancestors that make up the resource's lineage.
	Path []PathSegment `json:"path"`
	// resource_id is the resource's id.
	ResourceId   string                 `json:"resource_id"`
	ResourceType FolderResourceTypeType `json:"resource_type"`
}

FolderResource FolderResource describes a resource, and includes info about its lineage (parent/ancestors)..

func NewFolderResource added in v1.4.0 

func NewFolderResource(name string, organizationId string, parentId string, path []PathSegment, resourceId string, resourceType FolderResourceTypeType) *FolderResource

NewFolderResource instantiates a new FolderResource object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFolderResourceWithDefaults added in v1.4.0 

func NewFolderResourceWithDefaults() *FolderResource

NewFolderResourceWithDefaults instantiates a new FolderResource object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FolderResource) GetName added in v1.4.0 

func (o *FolderResource) GetName() string

GetName returns the Name field value.

func (*FolderResource) GetOrganizationId added in v1.4.0 

func (o *FolderResource) GetOrganizationId() string

GetOrganizationId returns the OrganizationId field value.

func (*FolderResource) GetParentId added in v1.4.0 

func (o *FolderResource) GetParentId() string

GetParentId returns the ParentId field value.

func (*FolderResource) GetPath added in v1.4.0 

func (o *FolderResource) GetPath() []PathSegment

GetPath returns the Path field value.

func (*FolderResource) GetResourceId added in v1.4.0 

func (o *FolderResource) GetResourceId() string

GetResourceId returns the ResourceId field value.

func (*FolderResource) GetResourceType added in v1.4.0 

func (o *FolderResource) GetResourceType() FolderResourceTypeType

GetResourceType returns the ResourceType field value.

func (*FolderResource) SetName added in v1.4.0 

func (o *FolderResource) SetName(v string)

SetName sets field value.

func (*FolderResource) SetOrganizationId added in v1.4.0 

func (o *FolderResource) SetOrganizationId(v string)

SetOrganizationId sets field value.

func (*FolderResource) SetParentId added in v1.4.0 

func (o *FolderResource) SetParentId(v string)

SetParentId sets field value.

func (*FolderResource) SetPath added in v1.4.0 

func (o *FolderResource) SetPath(v []PathSegment)

SetPath sets field value.

func (*FolderResource) SetResourceId added in v1.4.0 

func (o *FolderResource) SetResourceId(v string)

SetResourceId sets field value.

func (*FolderResource) SetResourceType added in v1.4.0 

func (o *FolderResource) SetResourceType(v FolderResourceTypeType)

SetResourceType sets field value.

type FolderResourceList added in v1.4.0 

type FolderResourceList struct {
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
	Resources  *[]FolderResource         `json:"resources,omitempty"`
}

FolderResourceList FolderResourceList contains a list of resources..

func NewFolderResourceList added in v1.4.0 

func NewFolderResourceList() *FolderResourceList

NewFolderResourceList instantiates a new FolderResourceList object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*FolderResourceList) GetPagination added in v1.4.0 

func (o *FolderResourceList) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*FolderResourceList) GetResources added in v1.4.0 

func (o *FolderResourceList) GetResources() []FolderResource

GetResources returns the Resources field value if set, zero value otherwise.

func (*FolderResourceList) SetPagination added in v1.4.0 

func (o *FolderResourceList) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*FolderResourceList) SetResources added in v1.4.0 

func (o *FolderResourceList) SetResources(v []FolderResource)

SetResources gets a reference to the given []FolderResource and assigns it to the Resources field.

type FolderResourceTypeType added in v1.4.0 

type FolderResourceTypeType string

FolderResourceTypeType the model 'FolderResourceTypeType'. 

const (
	FOLDERRESOURCETYPETYPE_FOLDER  FolderResourceTypeType = "FOLDER"
	FOLDERRESOURCETYPETYPE_CLUSTER FolderResourceTypeType = "CLUSTER"
)

List of FolderResourceType.Type.

func NewFolderResourceTypeTypeFromValue added in v1.4.0 

func NewFolderResourceTypeTypeFromValue(v string) (*FolderResourceTypeType, error)

NewFolderResourceTypeTypeFromValue returns a pointer to a valid FolderResourceTypeType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (FolderResourceTypeType) IsValid added in v1.4.0 

func (v FolderResourceTypeType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (FolderResourceTypeType) Ptr added in v1.4.0 

func (v FolderResourceTypeType) Ptr() *FolderResourceTypeType

Ptr returns reference to FolderResourceType.Type value.

type GetAllRolesForUserResponse added in v0.4.2 

type GetAllRolesForUserResponse struct {
	GroupRoles *[]BuiltInFromGroups `json:"group_roles,omitempty"`
	Roles      *[]BuiltInRole       `json:"roles,omitempty"`
}

GetAllRolesForUserResponse struct for GetAllRolesForUserResponse.

func NewGetAllRolesForUserResponse added in v0.4.2 

func NewGetAllRolesForUserResponse() *GetAllRolesForUserResponse

NewGetAllRolesForUserResponse instantiates a new GetAllRolesForUserResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetAllRolesForUserResponse) GetGroupRoles added in v1.1.0 

func (o *GetAllRolesForUserResponse) GetGroupRoles() []BuiltInFromGroups

GetGroupRoles returns the GroupRoles field value if set, zero value otherwise.

func (*GetAllRolesForUserResponse) GetRoles added in v0.4.2 

func (o *GetAllRolesForUserResponse) GetRoles() []BuiltInRole

GetRoles returns the Roles field value if set, zero value otherwise.

func (*GetAllRolesForUserResponse) SetGroupRoles added in v1.1.0 

func (o *GetAllRolesForUserResponse) SetGroupRoles(v []BuiltInFromGroups)

SetGroupRoles gets a reference to the given []BuiltInFromGroups and assigns it to the GroupRoles field.

func (*GetAllRolesForUserResponse) SetRoles added in v0.4.2 

func (o *GetAllRolesForUserResponse) SetRoles(v []BuiltInRole)

SetRoles gets a reference to the given []BuiltInRole and assigns it to the Roles field.

type GetConnectionStringOptions added in v0.3.4 

type GetConnectionStringOptions struct {
	Database *string

	SqlUser *string

	// os indicates the target operating system, used with formatting the default SSL certificate path. Required only for dedicated clusters.
	Os *string
}

GetConnectionStringOptions contains optional parameters for GetConnectionString.

type GetConnectionStringResponse added in v0.3.4 

type GetConnectionStringResponse struct {
	// connection_string contains the full connection string with parameters formatted inline.
	ConnectionString string                     `json:"connection_string"`
	Params           ConnectionStringParameters `json:"params"`
}

GetConnectionStringResponse struct for GetConnectionStringResponse.

func NewGetConnectionStringResponse added in v0.3.4 

func NewGetConnectionStringResponse(connectionString string, params ConnectionStringParameters) *GetConnectionStringResponse

NewGetConnectionStringResponse instantiates a new GetConnectionStringResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetConnectionStringResponseWithDefaults added in v1.4.0 

func NewGetConnectionStringResponseWithDefaults() *GetConnectionStringResponse

NewGetConnectionStringResponseWithDefaults instantiates a new GetConnectionStringResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetConnectionStringResponse) GetConnectionString added in v0.3.4 

func (o *GetConnectionStringResponse) GetConnectionString() string

GetConnectionString returns the ConnectionString field value.

func (*GetConnectionStringResponse) GetParams added in v0.3.4 

func (o *GetConnectionStringResponse) GetParams() ConnectionStringParameters

GetParams returns the Params field value.

func (*GetConnectionStringResponse) SetConnectionString added in v0.3.4 

func (o *GetConnectionStringResponse) SetConnectionString(v string)

SetConnectionString sets field value.

func (*GetConnectionStringResponse) SetParams added in v0.3.4 

func (o *GetConnectionStringResponse) SetParams(v ConnectionStringParameters)

SetParams sets field value.

type GetEgressRuleResponse added in v0.3.3 

type GetEgressRuleResponse struct {
	Rule EgressRule `json:"rule"`
}

GetEgressRuleResponse GetEgressRuleResponse is the response message to the GetEgressRule RPC..

func NewGetEgressRuleResponse added in v0.3.3 

func NewGetEgressRuleResponse(rule EgressRule) *GetEgressRuleResponse

NewGetEgressRuleResponse instantiates a new GetEgressRuleResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetEgressRuleResponseWithDefaults added in v0.3.3 

func NewGetEgressRuleResponseWithDefaults() *GetEgressRuleResponse

NewGetEgressRuleResponseWithDefaults instantiates a new GetEgressRuleResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetEgressRuleResponse) GetRule added in v0.3.3 

func (o *GetEgressRuleResponse) GetRule() EgressRule

GetRule returns the Rule field value.

func (*GetEgressRuleResponse) SetRule added in v0.3.3 

func (o *GetEgressRuleResponse) SetRule(v EgressRule)

SetRule sets field value.

type GetGroupOptions added in v1.1.0 

type GetGroupOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetGroupOptions contains optional parameters for GetGroup.

type GetGroupRequest added in v1.1.0 

type GetGroupRequest struct {
	Attributes         *string `json:"attributes,omitempty"`
	ExcludedAttributes *string `json:"excludedAttributes,omitempty"`
}

GetGroupRequest struct for GetGroupRequest.

func NewGetGroupRequest added in v1.1.0 

func NewGetGroupRequest() *GetGroupRequest

NewGetGroupRequest instantiates a new GetGroupRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetGroupRequest) GetAttributes added in v1.1.0 

func (o *GetGroupRequest) GetAttributes() string

GetAttributes returns the Attributes field value if set, zero value otherwise.

func (*GetGroupRequest) GetExcludedAttributes added in v1.1.0 

func (o *GetGroupRequest) GetExcludedAttributes() string

GetExcludedAttributes returns the ExcludedAttributes field value if set, zero value otherwise.

func (*GetGroupRequest) SetAttributes added in v1.1.0 

func (o *GetGroupRequest) SetAttributes(v string)

SetAttributes gets a reference to the given string and assigns it to the Attributes field.

func (*GetGroupRequest) SetExcludedAttributes added in v1.1.0 

func (o *GetGroupRequest) SetExcludedAttributes(v string)

SetExcludedAttributes gets a reference to the given string and assigns it to the ExcludedAttributes field.

type GetGroupsOptions added in v1.1.0 

type GetGroupsOptions struct {
	Attributes *string

	ExcludedAttributes *string

	Filter *string
}

GetGroupsOptions contains optional parameters for GetGroups.

type GetGroupsRequest added in v1.1.0 

type GetGroupsRequest struct {
	Attributes         *string `json:"attributes,omitempty"`
	ExcludedAttributes *string `json:"excludedAttributes,omitempty"`
	Filter             *string `json:"filter,omitempty"`
}

GetGroupsRequest struct for GetGroupsRequest.

func NewGetGroupsRequest added in v1.1.0 

func NewGetGroupsRequest() *GetGroupsRequest

NewGetGroupsRequest instantiates a new GetGroupsRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetGroupsRequest) GetAttributes added in v1.1.0 

func (o *GetGroupsRequest) GetAttributes() string

GetAttributes returns the Attributes field value if set, zero value otherwise.

func (*GetGroupsRequest) GetExcludedAttributes added in v1.1.0 

func (o *GetGroupsRequest) GetExcludedAttributes() string

GetExcludedAttributes returns the ExcludedAttributes field value if set, zero value otherwise.

func (*GetGroupsRequest) GetFilter added in v1.8.0 

func (o *GetGroupsRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*GetGroupsRequest) SetAttributes added in v1.1.0 

func (o *GetGroupsRequest) SetAttributes(v string)

SetAttributes gets a reference to the given string and assigns it to the Attributes field.

func (*GetGroupsRequest) SetExcludedAttributes added in v1.1.0 

func (o *GetGroupsRequest) SetExcludedAttributes(v string)

SetExcludedAttributes gets a reference to the given string and assigns it to the ExcludedAttributes field.

func (*GetGroupsRequest) SetFilter added in v1.8.0 

func (o *GetGroupsRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

type GetGroupsResponse added in v1.1.0 

type GetGroupsResponse struct {
	Resources    *[]ScimGroup `json:"Resources,omitempty"`
	ItemsPerPage *int32       `json:"itemsPerPage,omitempty"`
	Schemas      *[]string    `json:"schemas,omitempty"`
	TotalResults *int32       `json:"totalResults,omitempty"`
}

GetGroupsResponse struct for GetGroupsResponse.

func NewGetGroupsResponse added in v1.1.0 

func NewGetGroupsResponse() *GetGroupsResponse

NewGetGroupsResponse instantiates a new GetGroupsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetGroupsResponse) GetItemsPerPage added in v1.1.0 

func (o *GetGroupsResponse) GetItemsPerPage() int32

GetItemsPerPage returns the ItemsPerPage field value if set, zero value otherwise.

func (*GetGroupsResponse) GetResources added in v1.1.0 

func (o *GetGroupsResponse) GetResources() []ScimGroup

GetResources returns the Resources field value if set, zero value otherwise.

func (*GetGroupsResponse) GetSchemas added in v1.1.0 

func (o *GetGroupsResponse) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*GetGroupsResponse) GetTotalResults added in v1.1.0 

func (o *GetGroupsResponse) GetTotalResults() int32

GetTotalResults returns the TotalResults field value if set, zero value otherwise.

func (*GetGroupsResponse) SetItemsPerPage added in v1.1.0 

func (o *GetGroupsResponse) SetItemsPerPage(v int32)

SetItemsPerPage gets a reference to the given int32 and assigns it to the ItemsPerPage field.

func (*GetGroupsResponse) SetResources added in v1.1.0 

func (o *GetGroupsResponse) SetResources(v []ScimGroup)

SetResources gets a reference to the given []ScimGroup and assigns it to the Resources field.

func (*GetGroupsResponse) SetSchemas added in v1.1.0 

func (o *GetGroupsResponse) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*GetGroupsResponse) SetTotalResults added in v1.1.0 

func (o *GetGroupsResponse) SetTotalResults(v int32)

SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field.

type GetPersonUsersByEmailResponse added in v1.0.0 

type GetPersonUsersByEmailResponse struct {
	User *PersonUserInfo `json:"user,omitempty"`
}

GetPersonUsersByEmailResponse struct for GetPersonUsersByEmailResponse.

func NewGetPersonUsersByEmailResponse added in v1.0.0 

func NewGetPersonUsersByEmailResponse() *GetPersonUsersByEmailResponse

NewGetPersonUsersByEmailResponse instantiates a new GetPersonUsersByEmailResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetPersonUsersByEmailResponse) GetUser added in v1.0.0 

func (o *GetPersonUsersByEmailResponse) GetUser() PersonUserInfo

GetUser returns the User field value if set, zero value otherwise.

func (*GetPersonUsersByEmailResponse) SetUser added in v1.0.0 

func (o *GetPersonUsersByEmailResponse) SetUser(v PersonUserInfo)

SetUser gets a reference to the given PersonUserInfo and assigns it to the User field.

type GetPrivateEndpointTrustedOwnerResponse added in v1.6.0 

type GetPrivateEndpointTrustedOwnerResponse struct {
	TrustedOwner PrivateEndpointTrustedOwner `json:"trusted_owner"`
}

GetPrivateEndpointTrustedOwnerResponse struct for GetPrivateEndpointTrustedOwnerResponse.

func NewGetPrivateEndpointTrustedOwnerResponse added in v1.6.0 

func NewGetPrivateEndpointTrustedOwnerResponse(trustedOwner PrivateEndpointTrustedOwner) *GetPrivateEndpointTrustedOwnerResponse

NewGetPrivateEndpointTrustedOwnerResponse instantiates a new GetPrivateEndpointTrustedOwnerResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetPrivateEndpointTrustedOwnerResponseWithDefaults added in v1.6.0 

func NewGetPrivateEndpointTrustedOwnerResponseWithDefaults() *GetPrivateEndpointTrustedOwnerResponse

NewGetPrivateEndpointTrustedOwnerResponseWithDefaults instantiates a new GetPrivateEndpointTrustedOwnerResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetPrivateEndpointTrustedOwnerResponse) GetTrustedOwner added in v1.6.0 

func (o *GetPrivateEndpointTrustedOwnerResponse) GetTrustedOwner() PrivateEndpointTrustedOwner

GetTrustedOwner returns the TrustedOwner field value.

func (*GetPrivateEndpointTrustedOwnerResponse) SetTrustedOwner added in v1.6.0 

func (o *GetPrivateEndpointTrustedOwnerResponse) SetTrustedOwner(v PrivateEndpointTrustedOwner)

SetTrustedOwner sets field value.

type GetResourceTypeOptions added in v1.1.0 

type GetResourceTypeOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetResourceTypeOptions contains optional parameters for GetResourceType.

type GetResourceTypesOptions added in v1.1.0 

type GetResourceTypesOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetResourceTypesOptions contains optional parameters for GetResourceTypes.

type GetResourceTypesResponse added in v1.1.0 

type GetResourceTypesResponse struct {
	Resources    *[]ScimResourceType `json:"Resources,omitempty"`
	ItemsPerPage *int32              `json:"itemsPerPage,omitempty"`
	Schemas      *[]string           `json:"schemas,omitempty"`
	StartIndex   *int32              `json:"startIndex,omitempty"`
	TotalResults *int32              `json:"totalResults,omitempty"`
}

GetResourceTypesResponse struct for GetResourceTypesResponse.

func NewGetResourceTypesResponse added in v1.1.0 

func NewGetResourceTypesResponse() *GetResourceTypesResponse

NewGetResourceTypesResponse instantiates a new GetResourceTypesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetResourceTypesResponse) GetItemsPerPage added in v1.1.0 

func (o *GetResourceTypesResponse) GetItemsPerPage() int32

GetItemsPerPage returns the ItemsPerPage field value if set, zero value otherwise.

func (*GetResourceTypesResponse) GetResources added in v1.1.0 

func (o *GetResourceTypesResponse) GetResources() []ScimResourceType

GetResources returns the Resources field value if set, zero value otherwise.

func (*GetResourceTypesResponse) GetSchemas added in v1.1.0 

func (o *GetResourceTypesResponse) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*GetResourceTypesResponse) GetStartIndex added in v1.1.0 

func (o *GetResourceTypesResponse) GetStartIndex() int32

GetStartIndex returns the StartIndex field value if set, zero value otherwise.

func (*GetResourceTypesResponse) GetTotalResults added in v1.1.0 

func (o *GetResourceTypesResponse) GetTotalResults() int32

GetTotalResults returns the TotalResults field value if set, zero value otherwise.

func (*GetResourceTypesResponse) SetItemsPerPage added in v1.1.0 

func (o *GetResourceTypesResponse) SetItemsPerPage(v int32)

SetItemsPerPage gets a reference to the given int32 and assigns it to the ItemsPerPage field.

func (*GetResourceTypesResponse) SetResources added in v1.1.0 

func (o *GetResourceTypesResponse) SetResources(v []ScimResourceType)

SetResources gets a reference to the given []ScimResourceType and assigns it to the Resources field.

func (*GetResourceTypesResponse) SetSchemas added in v1.1.0 

func (o *GetResourceTypesResponse) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*GetResourceTypesResponse) SetStartIndex added in v1.1.0 

func (o *GetResourceTypesResponse) SetStartIndex(v int32)

SetStartIndex gets a reference to the given int32 and assigns it to the StartIndex field.

func (*GetResourceTypesResponse) SetTotalResults added in v1.1.0 

func (o *GetResourceTypesResponse) SetTotalResults(v int32)

SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field.

type GetSchemaOptions added in v1.1.0 

type GetSchemaOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetSchemaOptions contains optional parameters for GetSchema.

type GetSchemasOptions added in v1.1.0 

type GetSchemasOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetSchemasOptions contains optional parameters for GetSchemas.

type GetSchemasResponse added in v1.1.0 

type GetSchemasResponse struct {
	Resources    *[]ScimSchema `json:"Resources,omitempty"`
	ItemsPerPage *int32        `json:"itemsPerPage,omitempty"`
	Schemas      *[]string     `json:"schemas,omitempty"`
	StartIndex   *int32        `json:"startIndex,omitempty"`
	TotalResults *int32        `json:"totalResults,omitempty"`
}

GetSchemasResponse struct for GetSchemasResponse.

func NewGetSchemasResponse added in v1.1.0 

func NewGetSchemasResponse() *GetSchemasResponse

NewGetSchemasResponse instantiates a new GetSchemasResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetSchemasResponse) GetItemsPerPage added in v1.1.0 

func (o *GetSchemasResponse) GetItemsPerPage() int32

GetItemsPerPage returns the ItemsPerPage field value if set, zero value otherwise.

func (*GetSchemasResponse) GetResources added in v1.1.0 

func (o *GetSchemasResponse) GetResources() []ScimSchema

GetResources returns the Resources field value if set, zero value otherwise.

func (*GetSchemasResponse) GetSchemas added in v1.1.0 

func (o *GetSchemasResponse) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*GetSchemasResponse) GetStartIndex added in v1.1.0 

func (o *GetSchemasResponse) GetStartIndex() int32

GetStartIndex returns the StartIndex field value if set, zero value otherwise.

func (*GetSchemasResponse) GetTotalResults added in v1.1.0 

func (o *GetSchemasResponse) GetTotalResults() int32

GetTotalResults returns the TotalResults field value if set, zero value otherwise.

func (*GetSchemasResponse) SetItemsPerPage added in v1.1.0 

func (o *GetSchemasResponse) SetItemsPerPage(v int32)

SetItemsPerPage gets a reference to the given int32 and assigns it to the ItemsPerPage field.

func (*GetSchemasResponse) SetResources added in v1.1.0 

func (o *GetSchemasResponse) SetResources(v []ScimSchema)

SetResources gets a reference to the given []ScimSchema and assigns it to the Resources field.

func (*GetSchemasResponse) SetSchemas added in v1.1.0 

func (o *GetSchemasResponse) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*GetSchemasResponse) SetStartIndex added in v1.1.0 

func (o *GetSchemasResponse) SetStartIndex(v int32)

SetStartIndex gets a reference to the given int32 and assigns it to the StartIndex field.

func (*GetSchemasResponse) SetTotalResults added in v1.1.0 

func (o *GetSchemasResponse) SetTotalResults(v int32)

SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field.

type GetServiceProviderConfigResponse added in v1.1.0 

type GetServiceProviderConfigResponse struct {
	AuthenticationSchemes *[]ScimAuthenticationScheme `json:"authenticationSchemes,omitempty"`
	Bulk                  *ScimBulkSupport            `json:"bulk,omitempty"`
	ChangePassword        *ScimChangePasswordSupport  `json:"changePassword,omitempty"`
	Etag                  *ScimEtagSupport            `json:"etag,omitempty"`
	Filter                *ScimFilterSupport          `json:"filter,omitempty"`
	Meta                  *ScimMetadata               `json:"meta,omitempty"`
	Schemas               *[]string                   `json:"schemas,omitempty"`
	Sort                  *ScimSortSupport            `json:"sort,omitempty"`
}

GetServiceProviderConfigResponse struct for GetServiceProviderConfigResponse.

func NewGetServiceProviderConfigResponse added in v1.1.0 

func NewGetServiceProviderConfigResponse() *GetServiceProviderConfigResponse

NewGetServiceProviderConfigResponse instantiates a new GetServiceProviderConfigResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetServiceProviderConfigResponse) GetAuthenticationSchemes added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetAuthenticationSchemes() []ScimAuthenticationScheme

GetAuthenticationSchemes returns the AuthenticationSchemes field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetBulk added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetBulk() ScimBulkSupport

GetBulk returns the Bulk field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetChangePassword added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetChangePassword() ScimChangePasswordSupport

GetChangePassword returns the ChangePassword field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetEtag added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetEtag() ScimEtagSupport

GetEtag returns the Etag field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetFilter added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetFilter() ScimFilterSupport

GetFilter returns the Filter field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetMeta added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetMeta() ScimMetadata

GetMeta returns the Meta field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetSchemas added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) GetSort added in v1.1.0 

func (o *GetServiceProviderConfigResponse) GetSort() ScimSortSupport

GetSort returns the Sort field value if set, zero value otherwise.

func (*GetServiceProviderConfigResponse) SetAuthenticationSchemes added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetAuthenticationSchemes(v []ScimAuthenticationScheme)

SetAuthenticationSchemes gets a reference to the given []ScimAuthenticationScheme and assigns it to the AuthenticationSchemes field.

func (*GetServiceProviderConfigResponse) SetBulk added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetBulk(v ScimBulkSupport)

SetBulk gets a reference to the given ScimBulkSupport and assigns it to the Bulk field.

func (*GetServiceProviderConfigResponse) SetChangePassword added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetChangePassword(v ScimChangePasswordSupport)

SetChangePassword gets a reference to the given ScimChangePasswordSupport and assigns it to the ChangePassword field.

func (*GetServiceProviderConfigResponse) SetEtag added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetEtag(v ScimEtagSupport)

SetEtag gets a reference to the given ScimEtagSupport and assigns it to the Etag field.

func (*GetServiceProviderConfigResponse) SetFilter added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetFilter(v ScimFilterSupport)

SetFilter gets a reference to the given ScimFilterSupport and assigns it to the Filter field.

func (*GetServiceProviderConfigResponse) SetMeta added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetMeta(v ScimMetadata)

SetMeta gets a reference to the given ScimMetadata and assigns it to the Meta field.

func (*GetServiceProviderConfigResponse) SetSchemas added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*GetServiceProviderConfigResponse) SetSort added in v1.1.0 

func (o *GetServiceProviderConfigResponse) SetSort(v ScimSortSupport)

SetSort gets a reference to the given ScimSortSupport and assigns it to the Sort field.

type GetUserOptions added in v1.1.0 

type GetUserOptions struct {
	Attributes *string

	ExcludedAttributes *string
}

GetUserOptions contains optional parameters for GetUser.

type GetUserRequest added in v1.1.0 

type GetUserRequest struct {
	Attributes         *string `json:"attributes,omitempty"`
	ExcludedAttributes *string `json:"excludedAttributes,omitempty"`
}

GetUserRequest struct for GetUserRequest.

func NewGetUserRequest added in v1.1.0 

func NewGetUserRequest() *GetUserRequest

NewGetUserRequest instantiates a new GetUserRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetUserRequest) GetAttributes added in v1.1.0 

func (o *GetUserRequest) GetAttributes() string

GetAttributes returns the Attributes field value if set, zero value otherwise.

func (*GetUserRequest) GetExcludedAttributes added in v1.1.0 

func (o *GetUserRequest) GetExcludedAttributes() string

GetExcludedAttributes returns the ExcludedAttributes field value if set, zero value otherwise.

func (*GetUserRequest) SetAttributes added in v1.1.0 

func (o *GetUserRequest) SetAttributes(v string)

SetAttributes gets a reference to the given string and assigns it to the Attributes field.

func (*GetUserRequest) SetExcludedAttributes added in v1.1.0 

func (o *GetUserRequest) SetExcludedAttributes(v string)

SetExcludedAttributes gets a reference to the given string and assigns it to the ExcludedAttributes field.

type GetUsersOptions added in v1.1.0 

type GetUsersOptions struct {
	Filter *string

	Attributes *string

	ExcludedAttributes *string
}

GetUsersOptions contains optional parameters for GetUsers.

type GetUsersRequest added in v1.1.0 

type GetUsersRequest struct {
	Attributes         *string `json:"attributes,omitempty"`
	ExcludedAttributes *string `json:"excludedAttributes,omitempty"`
	Filter             *string `json:"filter,omitempty"`
}

GetUsersRequest struct for GetUsersRequest.

func NewGetUsersRequest added in v1.1.0 

func NewGetUsersRequest() *GetUsersRequest

NewGetUsersRequest instantiates a new GetUsersRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetUsersRequest) GetAttributes added in v1.1.0 

func (o *GetUsersRequest) GetAttributes() string

GetAttributes returns the Attributes field value if set, zero value otherwise.

func (*GetUsersRequest) GetExcludedAttributes added in v1.1.0 

func (o *GetUsersRequest) GetExcludedAttributes() string

GetExcludedAttributes returns the ExcludedAttributes field value if set, zero value otherwise.

func (*GetUsersRequest) GetFilter added in v1.1.0 

func (o *GetUsersRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*GetUsersRequest) SetAttributes added in v1.1.0 

func (o *GetUsersRequest) SetAttributes(v string)

SetAttributes gets a reference to the given string and assigns it to the Attributes field.

func (*GetUsersRequest) SetExcludedAttributes added in v1.1.0 

func (o *GetUsersRequest) SetExcludedAttributes(v string)

SetExcludedAttributes gets a reference to the given string and assigns it to the ExcludedAttributes field.

func (*GetUsersRequest) SetFilter added in v1.1.0 

func (o *GetUsersRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

type GetUsersResponse added in v1.1.0 

type GetUsersResponse struct {
	Resources    *[]ScimUser `json:"Resources,omitempty"`
	Schemas      *[]string   `json:"schemas,omitempty"`
	TotalResults *int32      `json:"totalResults,omitempty"`
}

GetUsersResponse struct for GetUsersResponse.

func NewGetUsersResponse added in v1.1.0 

func NewGetUsersResponse() *GetUsersResponse

NewGetUsersResponse instantiates a new GetUsersResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*GetUsersResponse) GetResources added in v1.1.0 

func (o *GetUsersResponse) GetResources() []ScimUser

GetResources returns the Resources field value if set, zero value otherwise.

func (*GetUsersResponse) GetSchemas added in v1.1.0 

func (o *GetUsersResponse) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*GetUsersResponse) GetTotalResults added in v1.1.0 

func (o *GetUsersResponse) GetTotalResults() int32

GetTotalResults returns the TotalResults field value if set, zero value otherwise.

func (*GetUsersResponse) SetResources added in v1.1.0 

func (o *GetUsersResponse) SetResources(v []ScimUser)

SetResources gets a reference to the given []ScimUser and assigns it to the Resources field.

func (*GetUsersResponse) SetSchemas added in v1.1.0 

func (o *GetUsersResponse) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*GetUsersResponse) SetTotalResults added in v1.1.0 

func (o *GetUsersResponse) SetTotalResults(v int32)

SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field.

type Invoice 

type Invoice struct {
	// adjustments is a list of credits or costs that adjust the value of the invoice (e.g. a Serverless Free Credit or Premium Support adjustment). Unlike line items, adjustments are not tied to a particular cluster.
	Adjustments *[]InvoiceAdjustment `json:"adjustments,omitempty"`
	// balances are the amounts of currency left at the time of the invoice.
	Balances []CurrencyAmount `json:"balances"`
	// FolderResources is a list of resources in the organization and their folder paths.
	FolderResources *[]FolderResource `json:"folder_resources,omitempty"`
	// invoice_id is the unique ID representing the invoice.
	InvoiceId string `json:"invoice_id"`
	// invoice_items are sorted by the cluster name.
	InvoiceItems []InvoiceItem `json:"invoice_items"`
	// period_end is the end of the billing period (exclusive).
	PeriodEnd time.Time `json:"period_end"`
	// period_start is the start of the billing period (inclusive).
	PeriodStart time.Time `json:"period_start"`
	// totals is a list of the total amounts per currency.
	Totals []CurrencyAmount `json:"totals"`
}

Invoice Invoice message represents the details and the total charges associated with one billing period, which starts at the beginning of the month and ends at the beginning of the next month. The message also includes details about each invoice item..

func NewInvoice 

func NewInvoice(balances []CurrencyAmount, invoiceId string, invoiceItems []InvoiceItem, periodEnd time.Time, periodStart time.Time, totals []CurrencyAmount) *Invoice

NewInvoice instantiates a new Invoice object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewInvoiceWithDefaults 

func NewInvoiceWithDefaults() *Invoice

NewInvoiceWithDefaults instantiates a new Invoice object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Invoice) GetAdjustments added in v0.4.2 

func (o *Invoice) GetAdjustments() []InvoiceAdjustment

GetAdjustments returns the Adjustments field value if set, zero value otherwise.

func (*Invoice) GetBalances 

func (o *Invoice) GetBalances() []CurrencyAmount

GetBalances returns the Balances field value.

func (*Invoice) GetFolderResources added in v1.8.0 

func (o *Invoice) GetFolderResources() []FolderResource

GetFolderResources returns the FolderResources field value if set, zero value otherwise.

func (*Invoice) GetInvoiceId 

func (o *Invoice) GetInvoiceId() string

GetInvoiceId returns the InvoiceId field value.

func (*Invoice) GetInvoiceItems 

func (o *Invoice) GetInvoiceItems() []InvoiceItem

GetInvoiceItems returns the InvoiceItems field value.

func (*Invoice) GetPeriodEnd 

func (o *Invoice) GetPeriodEnd() time.Time

GetPeriodEnd returns the PeriodEnd field value.

func (*Invoice) GetPeriodStart 

func (o *Invoice) GetPeriodStart() time.Time

GetPeriodStart returns the PeriodStart field value.

func (*Invoice) GetTotals 

func (o *Invoice) GetTotals() []CurrencyAmount

GetTotals returns the Totals field value.

func (*Invoice) SetAdjustments added in v0.4.2 

func (o *Invoice) SetAdjustments(v []InvoiceAdjustment)

SetAdjustments gets a reference to the given []InvoiceAdjustment and assigns it to the Adjustments field.

func (*Invoice) SetBalances 

func (o *Invoice) SetBalances(v []CurrencyAmount)

SetBalances sets field value.

func (*Invoice) SetFolderResources added in v1.8.0 

func (o *Invoice) SetFolderResources(v []FolderResource)

SetFolderResources gets a reference to the given []FolderResource and assigns it to the FolderResources field.

func (*Invoice) SetInvoiceId 

func (o *Invoice) SetInvoiceId(v string)

SetInvoiceId sets field value.

func (*Invoice) SetInvoiceItems 

func (o *Invoice) SetInvoiceItems(v []InvoiceItem)

SetInvoiceItems sets field value.

func (*Invoice) SetPeriodEnd 

func (o *Invoice) SetPeriodEnd(v time.Time)

SetPeriodEnd sets field value.

func (*Invoice) SetPeriodStart 

func (o *Invoice) SetPeriodStart(v time.Time)

SetPeriodStart sets field value.

func (*Invoice) SetTotals 

func (o *Invoice) SetTotals(v []CurrencyAmount)

SetTotals sets field value.

type InvoiceAdjustment added in v0.4.2 

type InvoiceAdjustment struct {
	Amount CurrencyAmount `json:"amount"`
	// name identifies the adjustment.
	Name string `json:"name"`
}

InvoiceAdjustment struct for InvoiceAdjustment.

func NewInvoiceAdjustment added in v0.4.2 

func NewInvoiceAdjustment(amount CurrencyAmount, name string) *InvoiceAdjustment

NewInvoiceAdjustment instantiates a new InvoiceAdjustment object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewInvoiceAdjustmentWithDefaults added in v0.4.2 

func NewInvoiceAdjustmentWithDefaults() *InvoiceAdjustment

NewInvoiceAdjustmentWithDefaults instantiates a new InvoiceAdjustment object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*InvoiceAdjustment) GetAmount added in v0.4.2 

func (o *InvoiceAdjustment) GetAmount() CurrencyAmount

GetAmount returns the Amount field value.

func (*InvoiceAdjustment) GetName added in v0.4.2 

func (o *InvoiceAdjustment) GetName() string

GetName returns the Name field value.

func (*InvoiceAdjustment) SetAmount added in v0.4.2 

func (o *InvoiceAdjustment) SetAmount(v CurrencyAmount)

SetAmount sets field value.

func (*InvoiceAdjustment) SetName added in v0.4.2 

func (o *InvoiceAdjustment) SetName(v string)

SetName sets field value.

type InvoiceItem 

type InvoiceItem struct {
	Cluster Cluster `json:"cluster"`
	// line_items contain all the relevant line items from the Metronome invoice.
	LineItems []LineItem `json:"line_items"`
	// totals is a list of the total amounts of line items per currency.
	Totals []CurrencyAmount `json:"totals"`
}

InvoiceItem struct for InvoiceItem.

func NewInvoiceItem 

func NewInvoiceItem(cluster Cluster, lineItems []LineItem, totals []CurrencyAmount) *InvoiceItem

NewInvoiceItem instantiates a new InvoiceItem object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewInvoiceItemWithDefaults 

func NewInvoiceItemWithDefaults() *InvoiceItem

NewInvoiceItemWithDefaults instantiates a new InvoiceItem object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*InvoiceItem) GetCluster 

func (o *InvoiceItem) GetCluster() Cluster

GetCluster returns the Cluster field value.

func (*InvoiceItem) GetLineItems 

func (o *InvoiceItem) GetLineItems() []LineItem

GetLineItems returns the LineItems field value.

func (*InvoiceItem) GetTotals 

func (o *InvoiceItem) GetTotals() []CurrencyAmount

GetTotals returns the Totals field value.

func (*InvoiceItem) SetCluster 

func (o *InvoiceItem) SetCluster(v Cluster)

SetCluster sets field value.

func (*InvoiceItem) SetLineItems 

func (o *InvoiceItem) SetLineItems(v []LineItem)

SetLineItems sets field value.

func (*InvoiceItem) SetTotals 

func (o *InvoiceItem) SetTotals(v []CurrencyAmount)

SetTotals sets field value.

type KeysetPaginationRequest 

type KeysetPaginationRequest struct {
	AsOfTime  *time.Time `json:"as_of_time,omitempty"`
	Limit     *int32     `json:"limit,omitempty"`
	Page      *string    `json:"page,omitempty"`
	SortOrder *SortOrder `json:"sort_order,omitempty"`
}

KeysetPaginationRequest struct for KeysetPaginationRequest.

func NewKeysetPaginationRequest 

func NewKeysetPaginationRequest() *KeysetPaginationRequest

NewKeysetPaginationRequest instantiates a new KeysetPaginationRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*KeysetPaginationRequest) GetAsOfTime 

func (o *KeysetPaginationRequest) GetAsOfTime() time.Time

GetAsOfTime returns the AsOfTime field value if set, zero value otherwise.

func (*KeysetPaginationRequest) GetLimit 

func (o *KeysetPaginationRequest) GetLimit() int32

GetLimit returns the Limit field value if set, zero value otherwise.

func (*KeysetPaginationRequest) GetPage 

func (o *KeysetPaginationRequest) GetPage() string

GetPage returns the Page field value if set, zero value otherwise.

func (*KeysetPaginationRequest) GetSortOrder 

func (o *KeysetPaginationRequest) GetSortOrder() SortOrder

GetSortOrder returns the SortOrder field value if set, zero value otherwise.

func (*KeysetPaginationRequest) SetAsOfTime 

func (o *KeysetPaginationRequest) SetAsOfTime(v time.Time)

SetAsOfTime gets a reference to the given time.Time and assigns it to the AsOfTime field.

func (*KeysetPaginationRequest) SetLimit 

func (o *KeysetPaginationRequest) SetLimit(v int32)

SetLimit gets a reference to the given int32 and assigns it to the Limit field.

func (*KeysetPaginationRequest) SetPage 

func (o *KeysetPaginationRequest) SetPage(v string)

SetPage gets a reference to the given string and assigns it to the Page field.

func (*KeysetPaginationRequest) SetSortOrder 

func (o *KeysetPaginationRequest) SetSortOrder(v SortOrder)

SetSortOrder gets a reference to the given SortOrder and assigns it to the SortOrder field.

type KeysetPaginationResponse 

type KeysetPaginationResponse struct {
	NextPage     *string `json:"next_page,omitempty"`
	PreviousPage *string `json:"previous_page,omitempty"`
}

KeysetPaginationResponse struct for KeysetPaginationResponse.

func NewKeysetPaginationResponse 

func NewKeysetPaginationResponse() *KeysetPaginationResponse

NewKeysetPaginationResponse instantiates a new KeysetPaginationResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*KeysetPaginationResponse) GetNextPage 

func (o *KeysetPaginationResponse) GetNextPage() string

GetNextPage returns the NextPage field value if set, zero value otherwise.

func (*KeysetPaginationResponse) GetPreviousPage 

func (o *KeysetPaginationResponse) GetPreviousPage() string

GetPreviousPage returns the PreviousPage field value if set, zero value otherwise.

func (*KeysetPaginationResponse) SetNextPage 

func (o *KeysetPaginationResponse) SetNextPage(v string)

SetNextPage gets a reference to the given string and assigns it to the NextPage field.

func (*KeysetPaginationResponse) SetPreviousPage 

func (o *KeysetPaginationResponse) SetPreviousPage(v string)

SetPreviousPage gets a reference to the given string and assigns it to the PreviousPage field.

type LineItem 

type LineItem struct {
	// description contains the details of the line item (i.e t3 micro).
	Description string `json:"description"`
	// quantity is the number of the specific line items used.
	Quantity     float64          `json:"quantity"`
	QuantityUnit QuantityUnitType `json:"quantity_unit"`
	Total        CurrencyAmount   `json:"total"`
	// unit_cost is the cost per unit of line item.
	UnitCost float64 `json:"unit_cost"`
}

LineItem struct for LineItem.

func NewLineItem 

func NewLineItem(description string, quantity float64, quantityUnit QuantityUnitType, total CurrencyAmount, unitCost float64) *LineItem

NewLineItem instantiates a new LineItem object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLineItemWithDefaults 

func NewLineItemWithDefaults() *LineItem

NewLineItemWithDefaults instantiates a new LineItem object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LineItem) GetDescription 

func (o *LineItem) GetDescription() string

GetDescription returns the Description field value.

func (*LineItem) GetQuantity 

func (o *LineItem) GetQuantity() float64

GetQuantity returns the Quantity field value.

func (*LineItem) GetQuantityUnit 

func (o *LineItem) GetQuantityUnit() QuantityUnitType

GetQuantityUnit returns the QuantityUnit field value.

func (*LineItem) GetTotal 

func (o *LineItem) GetTotal() CurrencyAmount

GetTotal returns the Total field value.

func (*LineItem) GetUnitCost 

func (o *LineItem) GetUnitCost() float64

GetUnitCost returns the UnitCost field value.

func (*LineItem) SetDescription 

func (o *LineItem) SetDescription(v string)

SetDescription sets field value.

func (*LineItem) SetQuantity 

func (o *LineItem) SetQuantity(v float64)

SetQuantity sets field value.

func (*LineItem) SetQuantityUnit 

func (o *LineItem) SetQuantityUnit(v QuantityUnitType)

SetQuantityUnit sets field value.

func (*LineItem) SetTotal 

func (o *LineItem) SetTotal(v CurrencyAmount)

SetTotal sets field value.

func (*LineItem) SetUnitCost 

func (o *LineItem) SetUnitCost(v float64)

SetUnitCost sets field value.

type ListAllowlistEntriesOptions 

type ListAllowlistEntriesOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListAllowlistEntriesOptions contains optional parameters for ListAllowlistEntries.

type ListAllowlistEntriesResponse 

type ListAllowlistEntriesResponse struct {
	Allowlist   []AllowlistEntry          `json:"allowlist"`
	Pagination  *KeysetPaginationResponse `json:"pagination,omitempty"`
	Propagating bool                      `json:"propagating"`
}

ListAllowlistEntriesResponse struct for ListAllowlistEntriesResponse.

func NewListAllowlistEntriesResponse 

func NewListAllowlistEntriesResponse(allowlist []AllowlistEntry, propagating bool) *ListAllowlistEntriesResponse

NewListAllowlistEntriesResponse instantiates a new ListAllowlistEntriesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListAllowlistEntriesResponseWithDefaults 

func NewListAllowlistEntriesResponseWithDefaults() *ListAllowlistEntriesResponse

NewListAllowlistEntriesResponseWithDefaults instantiates a new ListAllowlistEntriesResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListAllowlistEntriesResponse) GetAllowlist 

func (o *ListAllowlistEntriesResponse) GetAllowlist() []AllowlistEntry

GetAllowlist returns the Allowlist field value.

func (*ListAllowlistEntriesResponse) GetPagination 

func (o *ListAllowlistEntriesResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListAllowlistEntriesResponse) GetPropagating 

func (o *ListAllowlistEntriesResponse) GetPropagating() bool

GetPropagating returns the Propagating field value.

func (*ListAllowlistEntriesResponse) SetAllowlist 

func (o *ListAllowlistEntriesResponse) SetAllowlist(v []AllowlistEntry)

SetAllowlist sets field value.

func (*ListAllowlistEntriesResponse) SetPagination 

func (o *ListAllowlistEntriesResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListAllowlistEntriesResponse) SetPropagating 

func (o *ListAllowlistEntriesResponse) SetPropagating(v bool)

SetPropagating sets field value.

type ListApiKeysOptions added in v1.11.0 

type ListApiKeysOptions struct {
	// Optional filter to limit the response to include only api keys for a specific service account.
	ServiceAccountId *string

	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListApiKeysOptions contains optional parameters for ListApiKeys.

type ListApiKeysResponse added in v1.11.0 

type ListApiKeysResponse struct {
	ApiKeys    []ApiKey                  `json:"api_keys"`
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListApiKeysResponse struct for ListApiKeysResponse.

func NewListApiKeysResponse added in v1.11.0 

func NewListApiKeysResponse(apiKeys []ApiKey) *ListApiKeysResponse

NewListApiKeysResponse instantiates a new ListApiKeysResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListApiKeysResponseWithDefaults added in v1.11.0 

func NewListApiKeysResponseWithDefaults() *ListApiKeysResponse

NewListApiKeysResponseWithDefaults instantiates a new ListApiKeysResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListApiKeysResponse) GetApiKeys added in v1.11.0 

func (o *ListApiKeysResponse) GetApiKeys() []ApiKey

GetApiKeys returns the ApiKeys field value.

func (*ListApiKeysResponse) GetPagination added in v1.11.0 

func (o *ListApiKeysResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListApiKeysResponse) SetApiKeys added in v1.11.0 

func (o *ListApiKeysResponse) SetApiKeys(v []ApiKey)

SetApiKeys sets field value.

func (*ListApiKeysResponse) SetPagination added in v1.11.0 

func (o *ListApiKeysResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListApiOidcConfigOptions added in v1.5.0 

type ListApiOidcConfigOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListApiOidcConfigOptions contains optional parameters for ListApiOidcConfig.

type ListApiOidcConfigResponse added in v1.5.0 

type ListApiOidcConfigResponse struct {
	ApiOidcConfigs *[]ApiOidcConfig          `json:"api_oidc_configs,omitempty"`
	Pagination     *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListApiOidcConfigResponse list_api_oidc_config_response contains information about all the OIDC providers that can generate JWT tokens that can be used for authentication with the Cockroach Cloud API..

func NewListApiOidcConfigResponse added in v1.5.0 

func NewListApiOidcConfigResponse() *ListApiOidcConfigResponse

NewListApiOidcConfigResponse instantiates a new ListApiOidcConfigResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ListApiOidcConfigResponse) GetApiOidcConfigs added in v1.5.0 

func (o *ListApiOidcConfigResponse) GetApiOidcConfigs() []ApiOidcConfig

GetApiOidcConfigs returns the ApiOidcConfigs field value if set, zero value otherwise.

func (*ListApiOidcConfigResponse) GetPagination added in v1.5.0 

func (o *ListApiOidcConfigResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListApiOidcConfigResponse) SetApiOidcConfigs added in v1.5.0 

func (o *ListApiOidcConfigResponse) SetApiOidcConfigs(v []ApiOidcConfig)

SetApiOidcConfigs gets a reference to the given []ApiOidcConfig and assigns it to the ApiOidcConfigs field.

func (*ListApiOidcConfigResponse) SetPagination added in v1.5.0 

func (o *ListApiOidcConfigResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListAuditLogsOptions added in v1.1.0 

type ListAuditLogsOptions struct {
	// starting_from is the (exclusive) timestamp from which log entries will be returned in the response based on their created_at time, respecting the sort order specified in pagination. If unset, the default will be the current time if results are returned in descending order and the beginning of time if results are in ascending order.
	StartingFrom *time.Time

	// sort_order is the direction of pagination, with starting_from as the start point. If unset, the default is ascending order.   - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	SortOrder *string

	// limit is the number of entries requested in the response. Note that the response may still contain slightly more results, since the response will always contain every entry at a particular timestamp.
	Limit *int32
}

ListAuditLogsOptions contains optional parameters for ListAuditLogs.

type ListAuditLogsResponse added in v1.1.0 

type ListAuditLogsResponse struct {
	// entries is the contiguous list of audit log entries matching the pagination request, sorted in the order requested.
	Entries *[]AuditLogEntry `json:"entries,omitempty"`
	// next_starting_from is the timestamp the caller should use to continue paginating in the same direction. If the timestamp is unset, it means that there are no more entries in the direction of the request, and there never will be.
	NextStartingFrom *time.Time `json:"next_starting_from,omitempty"`
}

ListAuditLogsResponse struct for ListAuditLogsResponse.

func NewListAuditLogsResponse added in v1.1.0 

func NewListAuditLogsResponse() *ListAuditLogsResponse

NewListAuditLogsResponse instantiates a new ListAuditLogsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ListAuditLogsResponse) GetEntries added in v1.1.0 

func (o *ListAuditLogsResponse) GetEntries() []AuditLogEntry

GetEntries returns the Entries field value if set, zero value otherwise.

func (*ListAuditLogsResponse) GetNextStartingFrom added in v1.1.0 

func (o *ListAuditLogsResponse) GetNextStartingFrom() time.Time

GetNextStartingFrom returns the NextStartingFrom field value if set, zero value otherwise.

func (*ListAuditLogsResponse) SetEntries added in v1.1.0 

func (o *ListAuditLogsResponse) SetEntries(v []AuditLogEntry)

SetEntries gets a reference to the given []AuditLogEntry and assigns it to the Entries field.

func (*ListAuditLogsResponse) SetNextStartingFrom added in v1.1.0 

func (o *ListAuditLogsResponse) SetNextStartingFrom(v time.Time)

SetNextStartingFrom gets a reference to the given time.Time and assigns it to the NextStartingFrom field.

type ListAvailableRegionsOptions 

type ListAvailableRegionsOptions struct {
	// Optional CloudProvider for filtering.   - GCP: The Google Cloud Platform cloud provider.  - AWS: The Amazon Web Services cloud provider.  - AZURE: The Azure cloud provider.
	Provider *string

	// Optional filter to only show regions available for serverless clusters.
	Serverless *bool

	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListAvailableRegionsOptions contains optional parameters for ListAvailableRegions.

type ListAvailableRegionsResponse 

type ListAvailableRegionsResponse struct {
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
	Regions    []CloudProviderRegion     `json:"regions"`
}

ListAvailableRegionsResponse struct for ListAvailableRegionsResponse.

func NewListAvailableRegionsResponse 

func NewListAvailableRegionsResponse(regions []CloudProviderRegion) *ListAvailableRegionsResponse

NewListAvailableRegionsResponse instantiates a new ListAvailableRegionsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListAvailableRegionsResponseWithDefaults 

func NewListAvailableRegionsResponseWithDefaults() *ListAvailableRegionsResponse

NewListAvailableRegionsResponseWithDefaults instantiates a new ListAvailableRegionsResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListAvailableRegionsResponse) GetPagination 

func (o *ListAvailableRegionsResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListAvailableRegionsResponse) GetRegions 

func (o *ListAvailableRegionsResponse) GetRegions() []CloudProviderRegion

GetRegions returns the Regions field value.

func (*ListAvailableRegionsResponse) SetPagination 

func (o *ListAvailableRegionsResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListAvailableRegionsResponse) SetRegions 

func (o *ListAvailableRegionsResponse) SetRegions(v []CloudProviderRegion)

SetRegions sets field value.

type ListClusterNodesOptions 

type ListClusterNodesOptions struct {
	// Optional filter to limit response to a single region.
	RegionName *string

	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListClusterNodesOptions contains optional parameters for ListClusterNodes.

type ListClusterNodesResponse 

type ListClusterNodesResponse struct {
	Nodes      []Node                    `json:"nodes"`
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListClusterNodesResponse struct for ListClusterNodesResponse.

func NewListClusterNodesResponse 

func NewListClusterNodesResponse(nodes []Node) *ListClusterNodesResponse

NewListClusterNodesResponse instantiates a new ListClusterNodesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListClusterNodesResponseWithDefaults 

func NewListClusterNodesResponseWithDefaults() *ListClusterNodesResponse

NewListClusterNodesResponseWithDefaults instantiates a new ListClusterNodesResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListClusterNodesResponse) GetNodes 

func (o *ListClusterNodesResponse) GetNodes() []Node

GetNodes returns the Nodes field value.

func (*ListClusterNodesResponse) GetPagination 

func (o *ListClusterNodesResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListClusterNodesResponse) SetNodes 

func (o *ListClusterNodesResponse) SetNodes(v []Node)

SetNodes sets field value.

func (*ListClusterNodesResponse) SetPagination 

func (o *ListClusterNodesResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListClustersOptions 

type ListClustersOptions struct {
	// If `true`, show clusters that have been deleted or failed to initialize. Note that inactive clusters will only be included if the requesting user has organization-scoped cluster read permissions.
	ShowInactive *bool

	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListClustersOptions contains optional parameters for ListClusters.

type ListClustersResponse 

type ListClustersResponse struct {
	Clusters   []Cluster                 `json:"clusters"`
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListClustersResponse struct for ListClustersResponse.

func NewListClustersResponse 

func NewListClustersResponse(clusters []Cluster) *ListClustersResponse

NewListClustersResponse instantiates a new ListClustersResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListClustersResponseWithDefaults 

func NewListClustersResponseWithDefaults() *ListClustersResponse

NewListClustersResponseWithDefaults instantiates a new ListClustersResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListClustersResponse) GetClusters 

func (o *ListClustersResponse) GetClusters() []Cluster

GetClusters returns the Clusters field value.

func (*ListClustersResponse) GetPagination 

func (o *ListClustersResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListClustersResponse) SetClusters 

func (o *ListClustersResponse) SetClusters(v []Cluster)

SetClusters sets field value.

func (*ListClustersResponse) SetPagination 

func (o *ListClustersResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListDatabasesOptions 

type ListDatabasesOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListDatabasesOptions contains optional parameters for ListDatabases.

type ListDatabasesResponse added in v1.8.0 

type ListDatabasesResponse struct {
	Databases  []Database                `json:"databases"`
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListDatabasesResponse struct for ListDatabasesResponse.

func NewListDatabasesResponse added in v1.8.0 

func NewListDatabasesResponse(databases []Database) *ListDatabasesResponse

NewListDatabasesResponse instantiates a new ListDatabasesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListDatabasesResponseWithDefaults added in v1.8.0 

func NewListDatabasesResponseWithDefaults() *ListDatabasesResponse

NewListDatabasesResponseWithDefaults instantiates a new ListDatabasesResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListDatabasesResponse) GetDatabases added in v1.8.0 

func (o *ListDatabasesResponse) GetDatabases() []Database

GetDatabases returns the Databases field value.

func (*ListDatabasesResponse) GetPagination added in v1.8.0 

func (o *ListDatabasesResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListDatabasesResponse) SetDatabases added in v1.8.0 

func (o *ListDatabasesResponse) SetDatabases(v []Database)

SetDatabases sets field value.

func (*ListDatabasesResponse) SetPagination added in v1.8.0 

func (o *ListDatabasesResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListEgressRulesOptions added in v0.3.3 

type ListEgressRulesOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListEgressRulesOptions contains optional parameters for ListEgressRules.

type ListEgressRulesResponse added in v0.3.3 

type ListEgressRulesResponse struct {
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
	// rules are the egress rules associated with the given CockroachDB cluster.
	Rules *[]EgressRule `json:"rules,omitempty"`
}

ListEgressRulesResponse ListEgressRulesResponse is the output for the ListEgressRules RPC..

func NewListEgressRulesResponse added in v0.3.3 

func NewListEgressRulesResponse() *ListEgressRulesResponse

NewListEgressRulesResponse instantiates a new ListEgressRulesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ListEgressRulesResponse) GetPagination added in v0.3.3 

func (o *ListEgressRulesResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListEgressRulesResponse) GetRules added in v0.3.3 

func (o *ListEgressRulesResponse) GetRules() []EgressRule

GetRules returns the Rules field value if set, zero value otherwise.

func (*ListEgressRulesResponse) SetPagination added in v0.3.3 

func (o *ListEgressRulesResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListEgressRulesResponse) SetRules added in v0.3.3 

func (o *ListEgressRulesResponse) SetRules(v []EgressRule)

SetRules gets a reference to the given []EgressRule and assigns it to the Rules field.

type ListFolderContentsOptions added in v1.4.0 

type ListFolderContentsOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListFolderContentsOptions contains optional parameters for ListFolderContents.

type ListFoldersOptions added in v1.9.0 

type ListFoldersOptions struct {
	// Optional filter to limit the response to include only results that match the given absolute path to that folder. Preceding and ending \"/\" are optional. For example /folder1/folder2, /folder1/folder2/, folder1/folder2, and folder1/folder2/ are all equivalent. If no matching folder is found, an empty list is returned. Because folder paths are passed via the query parameters, they must be URL-encoded.
	Path *string

	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListFoldersOptions contains optional parameters for ListFolders.

type ListFoldersResponse added in v1.9.0 

type ListFoldersResponse struct {
	Folders    []FolderResource          `json:"folders"`
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
}

ListFoldersResponse struct for ListFoldersResponse.

func NewListFoldersResponse added in v1.9.0 

func NewListFoldersResponse(folders []FolderResource) *ListFoldersResponse

NewListFoldersResponse instantiates a new ListFoldersResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListFoldersResponseWithDefaults added in v1.9.0 

func NewListFoldersResponseWithDefaults() *ListFoldersResponse

NewListFoldersResponseWithDefaults instantiates a new ListFoldersResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListFoldersResponse) GetFolders added in v1.9.0 

func (o *ListFoldersResponse) GetFolders() []FolderResource

GetFolders returns the Folders field value.

func (*ListFoldersResponse) GetPagination added in v1.9.0 

func (o *ListFoldersResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListFoldersResponse) SetFolders added in v1.9.0 

func (o *ListFoldersResponse) SetFolders(v []FolderResource)

SetFolders sets field value.

func (*ListFoldersResponse) SetPagination added in v1.9.0 

func (o *ListFoldersResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

type ListInvoicesResponse 

type ListInvoicesResponse struct {
	// invoices are sorted by period_start time.
	Invoices []Invoice `json:"invoices"`
}

ListInvoicesResponse struct for ListInvoicesResponse.

func NewListInvoicesResponse 

func NewListInvoicesResponse(invoices []Invoice) *ListInvoicesResponse

NewListInvoicesResponse instantiates a new ListInvoicesResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListInvoicesResponseWithDefaults 

func NewListInvoicesResponseWithDefaults() *ListInvoicesResponse

NewListInvoicesResponseWithDefaults instantiates a new ListInvoicesResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListInvoicesResponse) GetInvoices 

func (o *ListInvoicesResponse) GetInvoices() []Invoice

GetInvoices returns the Invoices field value.

func (*ListInvoicesResponse) SetInvoices 

func (o *ListInvoicesResponse) SetInvoices(v []Invoice)

SetInvoices sets field value.

type ListMajorClusterVersionsOptions added in v0.4.1 

type ListMajorClusterVersionsOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListMajorClusterVersionsOptions contains optional parameters for ListMajorClusterVersions.

type ListMajorClusterVersionsResponse added in v0.4.1 

type ListMajorClusterVersionsResponse struct {
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
	Versions   []ClusterMajorVersion     `json:"versions"`
}

ListMajorClusterVersionsResponse struct for ListMajorClusterVersionsResponse.

func NewListMajorClusterVersionsResponse added in v0.4.1 

func NewListMajorClusterVersionsResponse(versions []ClusterMajorVersion) *ListMajorClusterVersionsResponse

NewListMajorClusterVersionsResponse instantiates a new ListMajorClusterVersionsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListMajorClusterVersionsResponseWithDefaults added in v0.4.1 

func NewListMajorClusterVersionsResponseWithDefaults() *ListMajorClusterVersionsResponse

NewListMajorClusterVersionsResponseWithDefaults instantiates a new ListMajorClusterVersionsResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListMajorClusterVersionsResponse) GetPagination added in v0.4.1 

func (o *ListMajorClusterVersionsResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListMajorClusterVersionsResponse) GetVersions added in v0.4.1 

func (o *ListMajorClusterVersionsResponse) GetVersions() []ClusterMajorVersion

GetVersions returns the Versions field value.

func (*ListMajorClusterVersionsResponse) SetPagination added in v0.4.1 

func (o *ListMajorClusterVersionsResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListMajorClusterVersionsResponse) SetVersions added in v0.4.1 

func (o *ListMajorClusterVersionsResponse) SetVersions(v []ClusterMajorVersion)

SetVersions sets field value.

type ListPrivateEndpointTrustedOwnersResponse added in v1.6.0 

type ListPrivateEndpointTrustedOwnersResponse struct {
	// trusted_owners describes the private endpoint trusted owner entries for the requested cluster.
	TrustedOwners *[]PrivateEndpointTrustedOwner `json:"trusted_owners,omitempty"`
}

ListPrivateEndpointTrustedOwnersResponse struct for ListPrivateEndpointTrustedOwnersResponse.

func NewListPrivateEndpointTrustedOwnersResponse added in v1.6.0 

func NewListPrivateEndpointTrustedOwnersResponse() *ListPrivateEndpointTrustedOwnersResponse

NewListPrivateEndpointTrustedOwnersResponse instantiates a new ListPrivateEndpointTrustedOwnersResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ListPrivateEndpointTrustedOwnersResponse) GetTrustedOwners added in v1.6.0 

func (o *ListPrivateEndpointTrustedOwnersResponse) GetTrustedOwners() []PrivateEndpointTrustedOwner

GetTrustedOwners returns the TrustedOwners field value if set, zero value otherwise.

func (*ListPrivateEndpointTrustedOwnersResponse) SetTrustedOwners added in v1.6.0 

func (o *ListPrivateEndpointTrustedOwnersResponse) SetTrustedOwners(v []PrivateEndpointTrustedOwner)

SetTrustedOwners gets a reference to the given []PrivateEndpointTrustedOwner and assigns it to the TrustedOwners field.

type ListRoleGrantsOptions added in v0.4.2 

type ListRoleGrantsOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListRoleGrantsOptions contains optional parameters for ListRoleGrants.

type ListRoleGrantsResponse added in v0.4.2 

type ListRoleGrantsResponse struct {
	Grants          *[]UserRoleGrants         `json:"grants,omitempty"`
	Pagination      *KeysetPaginationResponse `json:"pagination,omitempty"`
	UserGroupGrants *[]UserGroupRoleGrant     `json:"user_group_grants,omitempty"`
}

ListRoleGrantsResponse struct for ListRoleGrantsResponse.

func NewListRoleGrantsResponse added in v0.4.2 

func NewListRoleGrantsResponse() *ListRoleGrantsResponse

NewListRoleGrantsResponse instantiates a new ListRoleGrantsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ListRoleGrantsResponse) GetGrants added in v0.4.2 

func (o *ListRoleGrantsResponse) GetGrants() []UserRoleGrants

GetGrants returns the Grants field value if set, zero value otherwise.

func (*ListRoleGrantsResponse) GetPagination added in v0.4.2 

func (o *ListRoleGrantsResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListRoleGrantsResponse) GetUserGroupGrants added in v1.1.0 

func (o *ListRoleGrantsResponse) GetUserGroupGrants() []UserGroupRoleGrant

GetUserGroupGrants returns the UserGroupGrants field value if set, zero value otherwise.

func (*ListRoleGrantsResponse) SetGrants added in v0.4.2 

func (o *ListRoleGrantsResponse) SetGrants(v []UserRoleGrants)

SetGrants gets a reference to the given []UserRoleGrants and assigns it to the Grants field.

func (*ListRoleGrantsResponse) SetPagination added in v0.4.2 

func (o *ListRoleGrantsResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListRoleGrantsResponse) SetUserGroupGrants added in v1.1.0 

func (o *ListRoleGrantsResponse) SetUserGroupGrants(v []UserGroupRoleGrant)

SetUserGroupGrants gets a reference to the given []UserGroupRoleGrant and assigns it to the UserGroupGrants field.

type ListSQLUsersOptions 

type ListSQLUsersOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListSQLUsersOptions contains optional parameters for ListSQLUsers.

type ListSQLUsersResponse 

type ListSQLUsersResponse struct {
	Pagination *KeysetPaginationResponse `json:"pagination,omitempty"`
	Users      []SQLUser                 `json:"users"`
}

ListSQLUsersResponse struct for ListSQLUsersResponse.

func NewListSQLUsersResponse 

func NewListSQLUsersResponse(users []SQLUser) *ListSQLUsersResponse

NewListSQLUsersResponse instantiates a new ListSQLUsersResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListSQLUsersResponseWithDefaults 

func NewListSQLUsersResponseWithDefaults() *ListSQLUsersResponse

NewListSQLUsersResponseWithDefaults instantiates a new ListSQLUsersResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListSQLUsersResponse) GetPagination 

func (o *ListSQLUsersResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListSQLUsersResponse) GetUsers 

func (o *ListSQLUsersResponse) GetUsers() []SQLUser

GetUsers returns the Users field value.

func (*ListSQLUsersResponse) SetPagination 

func (o *ListSQLUsersResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListSQLUsersResponse) SetUsers 

func (o *ListSQLUsersResponse) SetUsers(v []SQLUser)

SetUsers sets field value.

type ListServiceAccountsOptions added in v1.11.0 

type ListServiceAccountsOptions struct {
	PaginationPage *string

	PaginationLimit *int32

	PaginationAsOfTime *time.Time

	//  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order.
	PaginationSortOrder *string
}

ListServiceAccountsOptions contains optional parameters for ListServiceAccounts.

type ListServiceAccountsResponse added in v1.11.0 

type ListServiceAccountsResponse struct {
	Pagination      *KeysetPaginationResponse `json:"pagination,omitempty"`
	ServiceAccounts []ServiceAccount          `json:"service_accounts"`
}

ListServiceAccountsResponse struct for ListServiceAccountsResponse.

func NewListServiceAccountsResponse added in v1.11.0 

func NewListServiceAccountsResponse(serviceAccounts []ServiceAccount) *ListServiceAccountsResponse

NewListServiceAccountsResponse instantiates a new ListServiceAccountsResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListServiceAccountsResponseWithDefaults added in v1.11.0 

func NewListServiceAccountsResponseWithDefaults() *ListServiceAccountsResponse

NewListServiceAccountsResponseWithDefaults instantiates a new ListServiceAccountsResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListServiceAccountsResponse) GetPagination added in v1.11.0 

func (o *ListServiceAccountsResponse) GetPagination() KeysetPaginationResponse

GetPagination returns the Pagination field value if set, zero value otherwise.

func (*ListServiceAccountsResponse) GetServiceAccounts added in v1.11.0 

func (o *ListServiceAccountsResponse) GetServiceAccounts() []ServiceAccount

GetServiceAccounts returns the ServiceAccounts field value.

func (*ListServiceAccountsResponse) SetPagination added in v1.11.0 

func (o *ListServiceAccountsResponse) SetPagination(v KeysetPaginationResponse)

SetPagination gets a reference to the given KeysetPaginationResponse and assigns it to the Pagination field.

func (*ListServiceAccountsResponse) SetServiceAccounts added in v1.11.0 

func (o *ListServiceAccountsResponse) SetServiceAccounts(v []ServiceAccount)

SetServiceAccounts sets field value.

type LogExportClusterInfo 

type LogExportClusterInfo struct {
	ClusterId   *string                        `json:"cluster_id,omitempty"`
	CreatedAt   *time.Time                     `json:"created_at,omitempty"`
	Spec        *LogExportClusterSpecification `json:"spec,omitempty"`
	Status      *LogExportStatus               `json:"status,omitempty"`
	UpdatedAt   *time.Time                     `json:"updated_at,omitempty"`
	UserMessage *string                        `json:"user_message,omitempty"`
}

LogExportClusterInfo LogExportClusterInfo contains a package of information that fully describes both the intended state of the log export configuration for a specific cluster but also some metadata around its deployment status, any error messages, and some timestamps..

func NewLogExportClusterInfo 

func NewLogExportClusterInfo() *LogExportClusterInfo

NewLogExportClusterInfo instantiates a new LogExportClusterInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*LogExportClusterInfo) GetClusterId 

func (o *LogExportClusterInfo) GetClusterId() string

GetClusterId returns the ClusterId field value if set, zero value otherwise.

func (*LogExportClusterInfo) GetCreatedAt 

func (o *LogExportClusterInfo) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*LogExportClusterInfo) GetSpec 

func (o *LogExportClusterInfo) GetSpec() LogExportClusterSpecification

GetSpec returns the Spec field value if set, zero value otherwise.

func (*LogExportClusterInfo) GetStatus 

func (o *LogExportClusterInfo) GetStatus() LogExportStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*LogExportClusterInfo) GetUpdatedAt 

func (o *LogExportClusterInfo) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*LogExportClusterInfo) GetUserMessage 

func (o *LogExportClusterInfo) GetUserMessage() string

GetUserMessage returns the UserMessage field value if set, zero value otherwise.

func (*LogExportClusterInfo) SetClusterId 

func (o *LogExportClusterInfo) SetClusterId(v string)

SetClusterId gets a reference to the given string and assigns it to the ClusterId field.

func (*LogExportClusterInfo) SetCreatedAt 

func (o *LogExportClusterInfo) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*LogExportClusterInfo) SetSpec 

func (o *LogExportClusterInfo) SetSpec(v LogExportClusterSpecification)

SetSpec gets a reference to the given LogExportClusterSpecification and assigns it to the Spec field.

func (*LogExportClusterInfo) SetStatus 

func (o *LogExportClusterInfo) SetStatus(v LogExportStatus)

SetStatus gets a reference to the given LogExportStatus and assigns it to the Status field.

func (*LogExportClusterInfo) SetUpdatedAt 

func (o *LogExportClusterInfo) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

func (*LogExportClusterInfo) SetUserMessage 

func (o *LogExportClusterInfo) SetUserMessage(v string)

SetUserMessage gets a reference to the given string and assigns it to the UserMessage field.

type LogExportClusterSpecification 

type LogExportClusterSpecification struct {
	// auth_principal is either the AWS Role ARN that identifies a role that the cluster account can assume to write to CloudWatch or the GCP Project ID that the cluster service account has permissions to write to for cloud logging.
	AuthPrincipal *string `json:"auth_principal,omitempty"`
	// groups is a collection of log group configurations to customize which CRDB channels get aggregated into different groups at the target sink. Unconfigured channels will be sent to the default locations via the settings above.
	Groups *[]LogExportGroup `json:"groups,omitempty"`
	// log_name is an identifier for the logs in the customer's log sink.
	LogName *string `json:"log_name,omitempty"`
	// omitted_channels is a list of channels that the user does not want to export logs for.
	OmittedChannels *[]string `json:"omitted_channels,omitempty"`
	// redact controls whether logs are redacted before forwarding to customer sinks. By default they are not redacted.
	Redact *bool `json:"redact,omitempty"`
	// region controls whether all logs are sent to a specific region in the customer sink. By default, logs will remain their region of origin depending on the cluster node's region.
	Region *string        `json:"region,omitempty"`
	Type   *LogExportType `json:"type,omitempty"`
}

LogExportClusterSpecification LogExportClusterSpecification contains all the data necessary to configure log export for an individual cluster. Users would supply this data via the API and also receive it back when inspecting the state of their log export configuration..

func NewLogExportClusterSpecification 

func NewLogExportClusterSpecification() *LogExportClusterSpecification

NewLogExportClusterSpecification instantiates a new LogExportClusterSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*LogExportClusterSpecification) GetAuthPrincipal 

func (o *LogExportClusterSpecification) GetAuthPrincipal() string

GetAuthPrincipal returns the AuthPrincipal field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetGroups added in v0.3.3 

func (o *LogExportClusterSpecification) GetGroups() []LogExportGroup

GetGroups returns the Groups field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetLogName 

func (o *LogExportClusterSpecification) GetLogName() string

GetLogName returns the LogName field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetOmittedChannels added in v1.4.0 

func (o *LogExportClusterSpecification) GetOmittedChannels() []string

GetOmittedChannels returns the OmittedChannels field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetRedact added in v0.3.3 

func (o *LogExportClusterSpecification) GetRedact() bool

GetRedact returns the Redact field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetRegion added in v0.3.3 

func (o *LogExportClusterSpecification) GetRegion() string

GetRegion returns the Region field value if set, zero value otherwise.

func (*LogExportClusterSpecification) GetType 

func (o *LogExportClusterSpecification) GetType() LogExportType

GetType returns the Type field value if set, zero value otherwise.

func (*LogExportClusterSpecification) SetAuthPrincipal 

func (o *LogExportClusterSpecification) SetAuthPrincipal(v string)

SetAuthPrincipal gets a reference to the given string and assigns it to the AuthPrincipal field.

func (*LogExportClusterSpecification) SetGroups added in v0.3.3 

func (o *LogExportClusterSpecification) SetGroups(v []LogExportGroup)

SetGroups gets a reference to the given []LogExportGroup and assigns it to the Groups field.

func (*LogExportClusterSpecification) SetLogName 

func (o *LogExportClusterSpecification) SetLogName(v string)

SetLogName gets a reference to the given string and assigns it to the LogName field.

func (*LogExportClusterSpecification) SetOmittedChannels added in v1.4.0 

func (o *LogExportClusterSpecification) SetOmittedChannels(v []string)

SetOmittedChannels gets a reference to the given []string and assigns it to the OmittedChannels field.

func (*LogExportClusterSpecification) SetRedact added in v0.3.3 

func (o *LogExportClusterSpecification) SetRedact(v bool)

SetRedact gets a reference to the given bool and assigns it to the Redact field.

func (*LogExportClusterSpecification) SetRegion added in v0.3.3 

func (o *LogExportClusterSpecification) SetRegion(v string)

SetRegion gets a reference to the given string and assigns it to the Region field.

func (*LogExportClusterSpecification) SetType 

func (o *LogExportClusterSpecification) SetType(v LogExportType)

SetType gets a reference to the given LogExportType and assigns it to the Type field.

type LogExportGroup added in v0.3.3 

type LogExportGroup struct {
	// channels is a list of CRDB log channels to include in this group.
	Channels []string `json:"channels"`
	// log_name is the name of the group, reflected in the log sink.
	LogName  string        `json:"log_name"`
	MinLevel *LogLevelType `json:"min_level,omitempty"`
	// redact is a boolean that governs whether this log group should aggregate redacted logs. Redaction settings will inherit from the cluster log export defaults if unset.
	Redact *bool `json:"redact,omitempty"`
}

LogExportGroup LogExportGroup contains an export configuration for a single log group which can route logs for a subset of CRDB channels..

func NewLogExportGroup added in v0.3.3 

func NewLogExportGroup(channels []string, logName string) *LogExportGroup

NewLogExportGroup instantiates a new LogExportGroup object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLogExportGroupWithDefaults added in v0.4.0 

func NewLogExportGroupWithDefaults() *LogExportGroup

NewLogExportGroupWithDefaults instantiates a new LogExportGroup object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LogExportGroup) GetChannels added in v0.3.3 

func (o *LogExportGroup) GetChannels() []string

GetChannels returns the Channels field value.

func (*LogExportGroup) GetLogName added in v0.3.3 

func (o *LogExportGroup) GetLogName() string

GetLogName returns the LogName field value.

func (*LogExportGroup) GetMinLevel added in v0.3.3 

func (o *LogExportGroup) GetMinLevel() LogLevelType

GetMinLevel returns the MinLevel field value if set, zero value otherwise.

func (*LogExportGroup) GetRedact added in v0.3.3 

func (o *LogExportGroup) GetRedact() bool

GetRedact returns the Redact field value if set, zero value otherwise.

func (*LogExportGroup) SetChannels added in v0.3.3 

func (o *LogExportGroup) SetChannels(v []string)

SetChannels sets field value.

func (*LogExportGroup) SetLogName added in v0.3.3 

func (o *LogExportGroup) SetLogName(v string)

SetLogName sets field value.

func (*LogExportGroup) SetMinLevel added in v0.3.3 

func (o *LogExportGroup) SetMinLevel(v LogLevelType)

SetMinLevel gets a reference to the given LogLevelType and assigns it to the MinLevel field.

func (*LogExportGroup) SetRedact added in v0.3.3 

func (o *LogExportGroup) SetRedact(v bool)

SetRedact gets a reference to the given bool and assigns it to the Redact field.

type LogExportStatus 

type LogExportStatus string

LogExportStatus LogExportStatus encodes the possible states that a configuration can be in as it is created, deployed, and disabled. 

const (
	LOGEXPORTSTATUS_DISABLED          LogExportStatus = "DISABLED"
	LOGEXPORTSTATUS_DISABLING         LogExportStatus = "DISABLING"
	LOGEXPORTSTATUS_DISABLE_FAILED    LogExportStatus = "DISABLE_FAILED"
	LOGEXPORTSTATUS_ENABLED           LogExportStatus = "ENABLED"
	LOGEXPORTSTATUS_ENABLING          LogExportStatus = "ENABLING"
	LOGEXPORTSTATUS_ENABLE_FAILED     LogExportStatus = "ENABLE_FAILED"
	LOGEXPORTSTATUS_CREDENTIALS_ERROR LogExportStatus = "CREDENTIALS_ERROR"
)

List of LogExportStatus.

func NewLogExportStatusFromValue 

func NewLogExportStatusFromValue(v string) (*LogExportStatus, error)

NewLogExportStatusFromValue returns a pointer to a valid LogExportStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (LogExportStatus) IsValid 

func (v LogExportStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (LogExportStatus) Ptr 

func (v LogExportStatus) Ptr() *LogExportStatus

Ptr returns reference to LogExportStatus value.

type LogExportType 

type LogExportType string

LogExportType LogExportType encodes the cloud selection that we're exporting to along with the cloud logging platform. Currently, each cloud has a single logging platform. 

const (
	LOGEXPORTTYPE_AWS_CLOUDWATCH    LogExportType = "AWS_CLOUDWATCH"
	LOGEXPORTTYPE_GCP_CLOUD_LOGGING LogExportType = "GCP_CLOUD_LOGGING"
)

List of LogExportType.

func NewLogExportTypeFromValue 

func NewLogExportTypeFromValue(v string) (*LogExportType, error)

NewLogExportTypeFromValue returns a pointer to a valid LogExportType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (LogExportType) IsValid 

func (v LogExportType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (LogExportType) Ptr 

func (v LogExportType) Ptr() *LogExportType

Ptr returns reference to LogExportType value.

type LogLevelType added in v1.0.0 

type LogLevelType string

LogLevelType - UNSPECIFIED: The unspecified log level includes all logs. - WARNING: The WARNING severity is used for situations which may require special handling, where normal operation is expected to resume automatically. - ERROR: The ERROR severity is used for situations that require special handling, where normal operation could not proceed as expected. Other operations can continue mostly unaffected. - FATAL: The FATAL severity is used for situations that require an immediate, hard server shutdown. A report is also sent to telemetry if telemetry is enabled. 

const (
	LOGLEVELTYPE_UNSPECIFIED LogLevelType = "UNSPECIFIED"
	LOGLEVELTYPE_WARNING     LogLevelType = "WARNING"
	LOGLEVELTYPE_ERROR       LogLevelType = "ERROR"
	LOGLEVELTYPE_FATAL       LogLevelType = "FATAL"
)

List of LogLevel.Type.

func NewLogLevelTypeFromValue added in v1.0.0 

func NewLogLevelTypeFromValue(v string) (*LogLevelType, error)

NewLogLevelTypeFromValue returns a pointer to a valid LogLevelType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (LogLevelType) IsValid added in v1.0.0 

func (v LogLevelType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (LogLevelType) Ptr added in v1.0.0 

func (v LogLevelType) Ptr() *LogLevelType

Ptr returns reference to LogLevel.Type value.

type MaintenanceWindow added in v1.2.0 

type MaintenanceWindow struct {
	// OffsetDuration is the duration from the start of a week (Monday 00:00 UTC) that this maintenance window will start after.  Must be less than 1 week.
	OffsetDuration string `json:"offset_duration"`
	// WindowDuration is the duration of the maintenance window.  Must be at least 6 hours and less than 1 week.
	WindowDuration string `json:"window_duration"`
}

MaintenanceWindow MaintenanceWindowSpec specifies a weekly recurring maintenance window for a cluster..

func NewMaintenanceWindow added in v1.2.0 

func NewMaintenanceWindow(offsetDuration string, windowDuration string) *MaintenanceWindow

NewMaintenanceWindow instantiates a new MaintenanceWindow object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMaintenanceWindowWithDefaults added in v1.2.0 

func NewMaintenanceWindowWithDefaults() *MaintenanceWindow

NewMaintenanceWindowWithDefaults instantiates a new MaintenanceWindow object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MaintenanceWindow) GetOffsetDuration added in v1.2.0 

func (o *MaintenanceWindow) GetOffsetDuration() string

GetOffsetDuration returns the OffsetDuration field value.

func (*MaintenanceWindow) GetWindowDuration added in v1.2.0 

func (o *MaintenanceWindow) GetWindowDuration() string

GetWindowDuration returns the WindowDuration field value.

func (*MaintenanceWindow) SetOffsetDuration added in v1.2.0 

func (o *MaintenanceWindow) SetOffsetDuration(v string)

SetOffsetDuration sets field value.

func (*MaintenanceWindow) SetWindowDuration added in v1.2.0 

func (o *MaintenanceWindow) SetWindowDuration(v string)

SetWindowDuration sets field value.

type MetricExportStatusType added in v1.0.0 

type MetricExportStatusType string

MetricExportStatusType the model 'MetricExportStatusType'. 

const (
	METRICEXPORTSTATUSTYPE_NOT_DEPLOYED MetricExportStatusType = "NOT_DEPLOYED"
	METRICEXPORTSTATUSTYPE_DISABLING    MetricExportStatusType = "DISABLING"
	METRICEXPORTSTATUSTYPE_ENABLING     MetricExportStatusType = "ENABLING"
	METRICEXPORTSTATUSTYPE_ENABLED      MetricExportStatusType = "ENABLED"
	METRICEXPORTSTATUSTYPE_ERROR        MetricExportStatusType = "ERROR"
)

List of MetricExportStatus.Type.

func NewMetricExportStatusTypeFromValue added in v1.0.0 

func NewMetricExportStatusTypeFromValue(v string) (*MetricExportStatusType, error)

NewMetricExportStatusTypeFromValue returns a pointer to a valid MetricExportStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (MetricExportStatusType) IsValid added in v1.0.0 

func (v MetricExportStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (MetricExportStatusType) Ptr added in v1.0.0 

func (v MetricExportStatusType) Ptr() *MetricExportStatusType

Ptr returns reference to MetricExportStatus.Type value.

type NetworkVisibilityType added in v1.0.0 

type NetworkVisibilityType string

NetworkVisibilityType the model 'NetworkVisibilityType'. 

const (
	NETWORKVISIBILITYTYPE_PUBLIC  NetworkVisibilityType = "PUBLIC"
	NETWORKVISIBILITYTYPE_PRIVATE NetworkVisibilityType = "PRIVATE"
)

List of NetworkVisibility.Type.

func NewNetworkVisibilityTypeFromValue added in v1.0.0 

func NewNetworkVisibilityTypeFromValue(v string) (*NetworkVisibilityType, error)

NewNetworkVisibilityTypeFromValue returns a pointer to a valid NetworkVisibilityType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (NetworkVisibilityType) IsValid added in v1.0.0 

func (v NetworkVisibilityType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (NetworkVisibilityType) Ptr added in v1.0.0 

func (v NetworkVisibilityType) Ptr() *NetworkVisibilityType

Ptr returns reference to NetworkVisibility.Type value.

type Node 

type Node struct {
	Name       string         `json:"name"`
	RegionName string         `json:"region_name"`
	Status     NodeStatusType `json:"status"`
}

Node struct for Node.

func NewNode 

func NewNode(name string, regionName string, status NodeStatusType) *Node

NewNode instantiates a new Node object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewNodeWithDefaults 

func NewNodeWithDefaults() *Node

NewNodeWithDefaults instantiates a new Node object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Node) GetName 

func (o *Node) GetName() string

GetName returns the Name field value.

func (*Node) GetRegionName 

func (o *Node) GetRegionName() string

GetRegionName returns the RegionName field value.

func (*Node) GetStatus 

func (o *Node) GetStatus() NodeStatusType

GetStatus returns the Status field value.

func (*Node) SetName 

func (o *Node) SetName(v string)

SetName sets field value.

func (*Node) SetRegionName 

func (o *Node) SetRegionName(v string)

SetRegionName sets field value.

func (*Node) SetStatus 

func (o *Node) SetStatus(v NodeStatusType)

SetStatus sets field value.

type NodeStatusType added in v1.0.0 

type NodeStatusType string

NodeStatusType the model 'NodeStatusType'. 

const (
	NODESTATUSTYPE_LIVE      NodeStatusType = "LIVE"
	NODESTATUSTYPE_NOT_READY NodeStatusType = "NOT_READY"
)

List of NodeStatus.Type.

func NewNodeStatusTypeFromValue added in v1.0.0 

func NewNodeStatusTypeFromValue(v string) (*NodeStatusType, error)

NewNodeStatusTypeFromValue returns a pointer to a valid NodeStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (NodeStatusType) IsValid added in v1.0.0 

func (v NodeStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (NodeStatusType) Ptr added in v1.0.0 

func (v NodeStatusType) Ptr() *NodeStatusType

Ptr returns reference to NodeStatus.Type value.

type OperatingSystemType added in v1.0.0 

type OperatingSystemType string

OperatingSystemType the model 'OperatingSystemType'. 

const (
	OPERATINGSYSTEMTYPE_MAC     OperatingSystemType = "MAC"
	OPERATINGSYSTEMTYPE_LINUX   OperatingSystemType = "LINUX"
	OPERATINGSYSTEMTYPE_WINDOWS OperatingSystemType = "WINDOWS"
)

List of OperatingSystem.Type.

func NewOperatingSystemTypeFromValue added in v1.0.0 

func NewOperatingSystemTypeFromValue(v string) (*OperatingSystemType, error)

NewOperatingSystemTypeFromValue returns a pointer to a valid OperatingSystemType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (OperatingSystemType) IsValid added in v1.0.0 

func (v OperatingSystemType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (OperatingSystemType) Ptr added in v1.0.0 

func (v OperatingSystemType) Ptr() *OperatingSystemType

Ptr returns reference to OperatingSystem.Type value.

type Organization added in v0.4.0 

type Organization struct {
	CreatedAt time.Time `json:"created_at"`
	Id        string    `json:"id"`
	Label     string    `json:"label"`
	Name      string    `json:"name"`
}

Organization struct for Organization.

func NewOrganization added in v0.4.0 

func NewOrganization(createdAt time.Time, id string, label string, name string) *Organization

NewOrganization instantiates a new Organization object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewOrganizationWithDefaults added in v0.4.0 

func NewOrganizationWithDefaults() *Organization

NewOrganizationWithDefaults instantiates a new Organization object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Organization) GetCreatedAt added in v0.4.0 

func (o *Organization) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value.

func (*Organization) GetId added in v0.4.0 

func (o *Organization) GetId() string

GetId returns the Id field value.

func (*Organization) GetLabel added in v0.4.0 

func (o *Organization) GetLabel() string

GetLabel returns the Label field value.

func (*Organization) GetName added in v0.4.0 

func (o *Organization) GetName() string

GetName returns the Name field value.

func (*Organization) SetCreatedAt added in v0.4.0 

func (o *Organization) SetCreatedAt(v time.Time)

SetCreatedAt sets field value.

func (*Organization) SetId added in v0.4.0 

func (o *Organization) SetId(v string)

SetId sets field value.

func (*Organization) SetLabel added in v0.4.0 

func (o *Organization) SetLabel(v string)

SetLabel sets field value.

func (*Organization) SetName added in v0.4.0 

func (o *Organization) SetName(v string)

SetName sets field value.

type OrganizationUserRoleType added in v1.0.0 

type OrganizationUserRoleType string

OrganizationUserRoleType - FOLDER_ADMIN: Limited Access: A folder admin role. - FOLDER_MOVER: Limited Access: A folder mover role. 

const (
	ORGANIZATIONUSERROLETYPE_BILLING_COORDINATOR     OrganizationUserRoleType = "BILLING_COORDINATOR"
	ORGANIZATIONUSERROLETYPE_ORG_ADMIN               OrganizationUserRoleType = "ORG_ADMIN"
	ORGANIZATIONUSERROLETYPE_ORG_MEMBER              OrganizationUserRoleType = "ORG_MEMBER"
	ORGANIZATIONUSERROLETYPE_CLUSTER_ADMIN           OrganizationUserRoleType = "CLUSTER_ADMIN"
	ORGANIZATIONUSERROLETYPE_CLUSTER_OPERATOR_WRITER OrganizationUserRoleType = "CLUSTER_OPERATOR_WRITER"
	ORGANIZATIONUSERROLETYPE_CLUSTER_DEVELOPER       OrganizationUserRoleType = "CLUSTER_DEVELOPER"
	ORGANIZATIONUSERROLETYPE_CLUSTER_CREATOR         OrganizationUserRoleType = "CLUSTER_CREATOR"
	ORGANIZATIONUSERROLETYPE_FOLDER_ADMIN            OrganizationUserRoleType = "FOLDER_ADMIN"
	ORGANIZATIONUSERROLETYPE_FOLDER_MOVER            OrganizationUserRoleType = "FOLDER_MOVER"
)

List of OrganizationUserRole.Type.

func NewOrganizationUserRoleTypeFromValue added in v1.0.0 

func NewOrganizationUserRoleTypeFromValue(v string) (*OrganizationUserRoleType, error)

NewOrganizationUserRoleTypeFromValue returns a pointer to a valid OrganizationUserRoleType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (OrganizationUserRoleType) IsValid added in v1.0.0 

func (v OrganizationUserRoleType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (OrganizationUserRoleType) Ptr added in v1.0.0 

func (v OrganizationUserRoleType) Ptr() *OrganizationUserRoleType

Ptr returns reference to OrganizationUserRole.Type value.

type PathSegment added in v1.4.0 

type PathSegment struct {
	// id is a folder id.
	Id *string `json:"id,omitempty"`
	// name is a folder name.
	Name *string `json:"name,omitempty"`
}

PathSegment struct for PathSegment.

func NewPathSegment added in v1.4.0 

func NewPathSegment() *PathSegment

NewPathSegment instantiates a new PathSegment object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*PathSegment) GetId added in v1.4.0 

func (o *PathSegment) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*PathSegment) GetName added in v1.4.0 

func (o *PathSegment) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*PathSegment) SetId added in v1.4.0 

func (o *PathSegment) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*PathSegment) SetName added in v1.4.0 

func (o *PathSegment) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type PersonUserInfo added in v1.0.0 

type PersonUserInfo struct {
	// email is an email address.
	Email *string `json:"email,omitempty"`
	// id is the user id.
	Id string `json:"id"`
}

PersonUserInfo struct for PersonUserInfo.

func NewPersonUserInfo added in v1.0.0 

func NewPersonUserInfo(id string) *PersonUserInfo

NewPersonUserInfo instantiates a new PersonUserInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPersonUserInfoWithDefaults added in v1.0.0 

func NewPersonUserInfoWithDefaults() *PersonUserInfo

NewPersonUserInfoWithDefaults instantiates a new PersonUserInfo object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PersonUserInfo) GetEmail added in v1.0.0 

func (o *PersonUserInfo) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise.

func (*PersonUserInfo) GetId added in v1.0.0 

func (o *PersonUserInfo) GetId() string

GetId returns the Id field value.

func (*PersonUserInfo) SetEmail added in v1.0.0 

func (o *PersonUserInfo) SetEmail(v string)

SetEmail gets a reference to the given string and assigns it to the Email field.

func (*PersonUserInfo) SetId added in v1.0.0 

func (o *PersonUserInfo) SetId(v string)

SetId sets field value.

type PlanType added in v1.0.0 

type PlanType string

PlanType - DEDICATED: A paid plan that offers dedicated hardware in any location. - CUSTOM: A plan option that is used for clusters whose machine configs are not supported in self-service. All INVOICE clusters are under this plan option. - SERVERLESS: A paid plan that runs on shared hardware and caps the users' maximum monthly spending to a user-specified (possibly 0) amount. 

const (
	PLANTYPE_DEDICATED  PlanType = "DEDICATED"
	PLANTYPE_CUSTOM     PlanType = "CUSTOM"
	PLANTYPE_SERVERLESS PlanType = "SERVERLESS"
)

List of Plan.Type.

func NewPlanTypeFromValue added in v1.0.0 

func NewPlanTypeFromValue(v string) (*PlanType, error)

NewPlanTypeFromValue returns a pointer to a valid PlanType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (PlanType) IsValid added in v1.0.0 

func (v PlanType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (PlanType) Ptr added in v1.0.0 

func (v PlanType) Ptr() *PlanType

Ptr returns reference to Plan.Type value.

type PrivateEndpointConnection added in v1.8.0 

type PrivateEndpointConnection struct {
	CloudProvider CloudProviderType `json:"cloud_provider"`
	// endpoint_id is the id of the private endpoint associated with this connection. The private endpoint is customer-created and its id is generated by the cloud provider at endpoint creation time.
	EndpointId string `json:"endpoint_id"`
	// endpoint_service_id is the id of the private endpoint service associated with this connection.
	EndpointServiceId string `json:"endpoint_service_id"`
	// external_owner_id uniquely identifies the owner of the private endpoint connection cloud resource. This idenfier is the AWS account id owning the PrivateLink connection. This field is only valid on AWS clusters.
	ExternalOwnerId *string `json:"external_owner_id,omitempty"`
	// region_name is the cloud provider region name (e.g. us-east-1).
	RegionName *string `json:"region_name,omitempty"`
	// service_name is the name of the private endpoints service that this connection corresponds to.
	ServiceName string                          `json:"service_name"`
	Status      PrivateEndpointConnectionStatus `json:"status"`
}

PrivateEndpointConnection struct for PrivateEndpointConnection.

func NewPrivateEndpointConnection added in v1.8.0 

func NewPrivateEndpointConnection(cloudProvider CloudProviderType, endpointId string, endpointServiceId string, serviceName string, status PrivateEndpointConnectionStatus) *PrivateEndpointConnection

NewPrivateEndpointConnection instantiates a new PrivateEndpointConnection object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrivateEndpointConnectionWithDefaults added in v1.8.0 

func NewPrivateEndpointConnectionWithDefaults() *PrivateEndpointConnection

NewPrivateEndpointConnectionWithDefaults instantiates a new PrivateEndpointConnection object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrivateEndpointConnection) GetCloudProvider added in v1.8.0 

func (o *PrivateEndpointConnection) GetCloudProvider() CloudProviderType

GetCloudProvider returns the CloudProvider field value.

func (*PrivateEndpointConnection) GetEndpointId added in v1.8.0 

func (o *PrivateEndpointConnection) GetEndpointId() string

GetEndpointId returns the EndpointId field value.

func (*PrivateEndpointConnection) GetEndpointServiceId added in v1.8.0 

func (o *PrivateEndpointConnection) GetEndpointServiceId() string

GetEndpointServiceId returns the EndpointServiceId field value.

func (*PrivateEndpointConnection) GetExternalOwnerId added in v1.8.0 

func (o *PrivateEndpointConnection) GetExternalOwnerId() string

GetExternalOwnerId returns the ExternalOwnerId field value if set, zero value otherwise.

func (*PrivateEndpointConnection) GetRegionName added in v1.8.0 

func (o *PrivateEndpointConnection) GetRegionName() string

GetRegionName returns the RegionName field value if set, zero value otherwise.

func (*PrivateEndpointConnection) GetServiceName added in v1.10.0 

func (o *PrivateEndpointConnection) GetServiceName() string

GetServiceName returns the ServiceName field value.

func (*PrivateEndpointConnection) GetStatus added in v1.8.0 

func (o *PrivateEndpointConnection) GetStatus() PrivateEndpointConnectionStatus

GetStatus returns the Status field value.

func (*PrivateEndpointConnection) SetCloudProvider added in v1.8.0 

func (o *PrivateEndpointConnection) SetCloudProvider(v CloudProviderType)

SetCloudProvider sets field value.

func (*PrivateEndpointConnection) SetEndpointId added in v1.8.0 

func (o *PrivateEndpointConnection) SetEndpointId(v string)

SetEndpointId sets field value.

func (*PrivateEndpointConnection) SetEndpointServiceId added in v1.8.0 

func (o *PrivateEndpointConnection) SetEndpointServiceId(v string)

SetEndpointServiceId sets field value.

func (*PrivateEndpointConnection) SetExternalOwnerId added in v1.8.0 

func (o *PrivateEndpointConnection) SetExternalOwnerId(v string)

SetExternalOwnerId gets a reference to the given string and assigns it to the ExternalOwnerId field.

func (*PrivateEndpointConnection) SetRegionName added in v1.8.0 

func (o *PrivateEndpointConnection) SetRegionName(v string)

SetRegionName gets a reference to the given string and assigns it to the RegionName field.

func (*PrivateEndpointConnection) SetServiceName added in v1.10.0 

func (o *PrivateEndpointConnection) SetServiceName(v string)

SetServiceName sets field value.

func (*PrivateEndpointConnection) SetStatus added in v1.8.0 

func (o *PrivateEndpointConnection) SetStatus(v PrivateEndpointConnectionStatus)

SetStatus sets field value.

type PrivateEndpointConnectionStatus added in v1.8.0 

type PrivateEndpointConnectionStatus string

PrivateEndpointConnectionStatus PrivateEndpointConnectionStatus enumerates the possible statuses for the private endpoints connection. 

const (
	PRIVATEENDPOINTCONNECTIONSTATUS_PENDING            PrivateEndpointConnectionStatus = "STATUS_PENDING"
	PRIVATEENDPOINTCONNECTIONSTATUS_PENDING_ACCEPTANCE PrivateEndpointConnectionStatus = "STATUS_PENDING_ACCEPTANCE"
	PRIVATEENDPOINTCONNECTIONSTATUS_AVAILABLE          PrivateEndpointConnectionStatus = "STATUS_AVAILABLE"
	PRIVATEENDPOINTCONNECTIONSTATUS_DELETING           PrivateEndpointConnectionStatus = "STATUS_DELETING"
	PRIVATEENDPOINTCONNECTIONSTATUS_DELETED            PrivateEndpointConnectionStatus = "STATUS_DELETED"
	PRIVATEENDPOINTCONNECTIONSTATUS_REJECTED           PrivateEndpointConnectionStatus = "STATUS_REJECTED"
	PRIVATEENDPOINTCONNECTIONSTATUS_FAILED             PrivateEndpointConnectionStatus = "STATUS_FAILED"
	PRIVATEENDPOINTCONNECTIONSTATUS_EXPIRED            PrivateEndpointConnectionStatus = "STATUS_EXPIRED"
)

List of PrivateEndpointConnectionStatus.

func NewPrivateEndpointConnectionStatusFromValue added in v1.8.0 

func NewPrivateEndpointConnectionStatusFromValue(v string) (*PrivateEndpointConnectionStatus, error)

NewPrivateEndpointConnectionStatusFromValue returns a pointer to a valid PrivateEndpointConnectionStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (PrivateEndpointConnectionStatus) IsValid added in v1.8.0 

func (v PrivateEndpointConnectionStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (PrivateEndpointConnectionStatus) Ptr added in v1.8.0 

func (v PrivateEndpointConnectionStatus) Ptr() *PrivateEndpointConnectionStatus

Ptr returns reference to PrivateEndpointConnectionStatus value.

type PrivateEndpointConnections added in v1.8.0 

type PrivateEndpointConnections struct {
	// Connections is a list of private endpoints.
	Connections []PrivateEndpointConnection `json:"connections"`
}

PrivateEndpointConnections struct for PrivateEndpointConnections.

func NewPrivateEndpointConnections added in v1.8.0 

func NewPrivateEndpointConnections(connections []PrivateEndpointConnection) *PrivateEndpointConnections

NewPrivateEndpointConnections instantiates a new PrivateEndpointConnections object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrivateEndpointConnectionsWithDefaults added in v1.8.0 

func NewPrivateEndpointConnectionsWithDefaults() *PrivateEndpointConnections

NewPrivateEndpointConnectionsWithDefaults instantiates a new PrivateEndpointConnections object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrivateEndpointConnections) GetConnections added in v1.8.0 

func (o *PrivateEndpointConnections) GetConnections() []PrivateEndpointConnection

GetConnections returns the Connections field value.

func (*PrivateEndpointConnections) SetConnections added in v1.8.0 

func (o *PrivateEndpointConnections) SetConnections(v []PrivateEndpointConnection)

SetConnections sets field value.

type PrivateEndpointService 

type PrivateEndpointService struct {
	// availability_zone_ids are the unique identifiers for the availability zones in which this service is available. Note these identifiers are unique even across typical cloud provider boundaries, for example AWS accounts or organizations. In AWS, availability zone ids for us-east-1 are use1-az1, use1-az2, use1-az3.
	AvailabilityZoneIds []string                     `json:"availability_zone_ids"`
	Aws                 *AWSPrivateLinkServiceDetail `json:"aws,omitempty"`
	CloudProvider       CloudProviderType            `json:"cloud_provider"`
	// endpoint_service_id uniquely identifies this private endpoint service. This is the cloud provider generated id for the service.
	EndpointServiceId string `json:"endpoint_service_id"`
	// name is the name of the private endpoints service.
	Name string `json:"name"`
	// region_name is the cloud provider region name (e.g. us-east-1).
	RegionName string                           `json:"region_name"`
	Status     PrivateEndpointServiceStatusType `json:"status"`
}

PrivateEndpointService struct for PrivateEndpointService.

func NewPrivateEndpointService 

func NewPrivateEndpointService(availabilityZoneIds []string, cloudProvider CloudProviderType, endpointServiceId string, name string, regionName string, status PrivateEndpointServiceStatusType) *PrivateEndpointService

NewPrivateEndpointService instantiates a new PrivateEndpointService object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrivateEndpointServiceWithDefaults 

func NewPrivateEndpointServiceWithDefaults() *PrivateEndpointService

NewPrivateEndpointServiceWithDefaults instantiates a new PrivateEndpointService object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrivateEndpointService) GetAvailabilityZoneIds added in v1.8.0 

func (o *PrivateEndpointService) GetAvailabilityZoneIds() []string

GetAvailabilityZoneIds returns the AvailabilityZoneIds field value.

func (*PrivateEndpointService) GetAws 

func (o *PrivateEndpointService) GetAws() AWSPrivateLinkServiceDetail

GetAws returns the Aws field value if set, zero value otherwise.

func (*PrivateEndpointService) GetCloudProvider 

func (o *PrivateEndpointService) GetCloudProvider() CloudProviderType

GetCloudProvider returns the CloudProvider field value.

func (*PrivateEndpointService) GetEndpointServiceId added in v1.8.0 

func (o *PrivateEndpointService) GetEndpointServiceId() string

GetEndpointServiceId returns the EndpointServiceId field value.

func (*PrivateEndpointService) GetName added in v1.8.0 

func (o *PrivateEndpointService) GetName() string

GetName returns the Name field value.

func (*PrivateEndpointService) GetRegionName 

func (o *PrivateEndpointService) GetRegionName() string

GetRegionName returns the RegionName field value.

func (*PrivateEndpointService) GetStatus 

func (o *PrivateEndpointService) GetStatus() PrivateEndpointServiceStatusType

GetStatus returns the Status field value.

func (*PrivateEndpointService) SetAvailabilityZoneIds added in v1.8.0 

func (o *PrivateEndpointService) SetAvailabilityZoneIds(v []string)

SetAvailabilityZoneIds sets field value.

func (*PrivateEndpointService) SetAws 

func (o *PrivateEndpointService) SetAws(v AWSPrivateLinkServiceDetail)

SetAws gets a reference to the given AWSPrivateLinkServiceDetail and assigns it to the Aws field.

func (*PrivateEndpointService) SetCloudProvider 

func (o *PrivateEndpointService) SetCloudProvider(v CloudProviderType)

SetCloudProvider sets field value.

func (*PrivateEndpointService) SetEndpointServiceId added in v1.8.0 

func (o *PrivateEndpointService) SetEndpointServiceId(v string)

SetEndpointServiceId sets field value.

func (*PrivateEndpointService) SetName added in v1.8.0 

func (o *PrivateEndpointService) SetName(v string)

SetName sets field value.

func (*PrivateEndpointService) SetRegionName 

func (o *PrivateEndpointService) SetRegionName(v string)

SetRegionName sets field value.

func (*PrivateEndpointService) SetStatus 

func (o *PrivateEndpointService) SetStatus(v PrivateEndpointServiceStatusType)

SetStatus sets field value.

type PrivateEndpointServiceStatusType added in v1.0.0 

type PrivateEndpointServiceStatusType string

PrivateEndpointServiceStatusType the model 'PrivateEndpointServiceStatusType'. 

const (
	PRIVATEENDPOINTSERVICESTATUSTYPE_CREATING      PrivateEndpointServiceStatusType = "CREATING"
	PRIVATEENDPOINTSERVICESTATUSTYPE_AVAILABLE     PrivateEndpointServiceStatusType = "AVAILABLE"
	PRIVATEENDPOINTSERVICESTATUSTYPE_CREATE_FAILED PrivateEndpointServiceStatusType = "CREATE_FAILED"
	PRIVATEENDPOINTSERVICESTATUSTYPE_DELETING      PrivateEndpointServiceStatusType = "DELETING"
	PRIVATEENDPOINTSERVICESTATUSTYPE_DELETE_FAILED PrivateEndpointServiceStatusType = "DELETE_FAILED"
)

List of PrivateEndpointServiceStatus.Type.

func NewPrivateEndpointServiceStatusTypeFromValue added in v1.0.0 

func NewPrivateEndpointServiceStatusTypeFromValue(v string) (*PrivateEndpointServiceStatusType, error)

NewPrivateEndpointServiceStatusTypeFromValue returns a pointer to a valid PrivateEndpointServiceStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (PrivateEndpointServiceStatusType) IsValid added in v1.0.0 

func (v PrivateEndpointServiceStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (PrivateEndpointServiceStatusType) Ptr added in v1.0.0 

func (v PrivateEndpointServiceStatusType) Ptr() *PrivateEndpointServiceStatusType

Ptr returns reference to PrivateEndpointServiceStatus.Type value.

type PrivateEndpointServices 

type PrivateEndpointServices struct {
	// services contains a list of all cluster related services.
	Services []PrivateEndpointService `json:"services"`
}

PrivateEndpointServices struct for PrivateEndpointServices.

func NewPrivateEndpointServices 

func NewPrivateEndpointServices(services []PrivateEndpointService) *PrivateEndpointServices

NewPrivateEndpointServices instantiates a new PrivateEndpointServices object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrivateEndpointServicesWithDefaults 

func NewPrivateEndpointServicesWithDefaults() *PrivateEndpointServices

NewPrivateEndpointServicesWithDefaults instantiates a new PrivateEndpointServices object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrivateEndpointServices) GetServices 

func (o *PrivateEndpointServices) GetServices() []PrivateEndpointService

GetServices returns the Services field value.

func (*PrivateEndpointServices) SetServices 

func (o *PrivateEndpointServices) SetServices(v []PrivateEndpointService)

SetServices sets field value.

type PrivateEndpointTrustedOwner added in v1.6.0 

type PrivateEndpointTrustedOwner struct {
	// cluster_id identifies the cluster to which this trusted owner entry applies.
	ClusterId string `json:"cluster_id"`
	// created_at is the time at which the entry was created.
	CreatedAt time.Time `json:"created_at"`
	// external_owner_id is the identifier of the owner within the cloud provider for private endpoint connections. A wildcard character (\"*\") can be used to denote all owners.
	ExternalOwnerId string `json:"external_owner_id"`
	// id is a UUID that uniquely identifies this trusted owner entry.
	Id   string                              `json:"id"`
	Type PrivateEndpointTrustedOwnerTypeType `json:"type"`
}

PrivateEndpointTrustedOwner PrivateEndpointTrustedOwner represents a trusted owner entry for private endpoint connections..

func NewPrivateEndpointTrustedOwner added in v1.6.0 

func NewPrivateEndpointTrustedOwner(clusterId string, createdAt time.Time, externalOwnerId string, id string, type_ PrivateEndpointTrustedOwnerTypeType) *PrivateEndpointTrustedOwner

NewPrivateEndpointTrustedOwner instantiates a new PrivateEndpointTrustedOwner object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrivateEndpointTrustedOwnerWithDefaults added in v1.6.0 

func NewPrivateEndpointTrustedOwnerWithDefaults() *PrivateEndpointTrustedOwner

NewPrivateEndpointTrustedOwnerWithDefaults instantiates a new PrivateEndpointTrustedOwner object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrivateEndpointTrustedOwner) GetClusterId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*PrivateEndpointTrustedOwner) GetCreatedAt added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value.

func (*PrivateEndpointTrustedOwner) GetExternalOwnerId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) GetExternalOwnerId() string

GetExternalOwnerId returns the ExternalOwnerId field value.

func (*PrivateEndpointTrustedOwner) GetId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) GetId() string

GetId returns the Id field value.

func (*PrivateEndpointTrustedOwner) GetType added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) GetType() PrivateEndpointTrustedOwnerTypeType

GetType returns the Type field value.

func (*PrivateEndpointTrustedOwner) SetClusterId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) SetClusterId(v string)

SetClusterId sets field value.

func (*PrivateEndpointTrustedOwner) SetCreatedAt added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) SetCreatedAt(v time.Time)

SetCreatedAt sets field value.

func (*PrivateEndpointTrustedOwner) SetExternalOwnerId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) SetExternalOwnerId(v string)

SetExternalOwnerId sets field value.

func (*PrivateEndpointTrustedOwner) SetId added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) SetId(v string)

SetId sets field value.

func (*PrivateEndpointTrustedOwner) SetType added in v1.6.0 

func (o *PrivateEndpointTrustedOwner) SetType(v PrivateEndpointTrustedOwnerTypeType)

SetType sets field value.

type PrivateEndpointTrustedOwnerTypeType added in v1.6.0 

type PrivateEndpointTrustedOwnerTypeType string

PrivateEndpointTrustedOwnerTypeType - AWS_ACCOUNT_ID: AWS_ACCOUNT_ID represents the 12-digit AWS account number. 

const (
	PRIVATEENDPOINTTRUSTEDOWNERTYPETYPE_AWS_ACCOUNT_ID PrivateEndpointTrustedOwnerTypeType = "AWS_ACCOUNT_ID"
)

List of PrivateEndpointTrustedOwnerType.Type.

func NewPrivateEndpointTrustedOwnerTypeTypeFromValue added in v1.6.0 

func NewPrivateEndpointTrustedOwnerTypeTypeFromValue(v string) (*PrivateEndpointTrustedOwnerTypeType, error)

NewPrivateEndpointTrustedOwnerTypeTypeFromValue returns a pointer to a valid PrivateEndpointTrustedOwnerTypeType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (PrivateEndpointTrustedOwnerTypeType) IsValid added in v1.6.0 

func (v PrivateEndpointTrustedOwnerTypeType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (PrivateEndpointTrustedOwnerTypeType) Ptr added in v1.6.0 

func (v PrivateEndpointTrustedOwnerTypeType) Ptr() *PrivateEndpointTrustedOwnerTypeType

Ptr returns reference to PrivateEndpointTrustedOwnerType.Type value.

type PrometheusMetricExportInfo added in v1.8.0 

type PrometheusMetricExportInfo struct {
	ClusterId string                  `json:"cluster_id"`
	Status    *MetricExportStatusType `json:"status,omitempty"`
	// targets is a map of ports exposing metrics to regions.
	Targets     *map[string]string `json:"targets,omitempty"`
	UserMessage *string            `json:"user_message,omitempty"`
}

PrometheusMetricExportInfo struct for PrometheusMetricExportInfo.

func NewPrometheusMetricExportInfo added in v1.8.0 

func NewPrometheusMetricExportInfo(clusterId string) *PrometheusMetricExportInfo

NewPrometheusMetricExportInfo instantiates a new PrometheusMetricExportInfo object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPrometheusMetricExportInfoWithDefaults added in v1.8.0 

func NewPrometheusMetricExportInfoWithDefaults() *PrometheusMetricExportInfo

NewPrometheusMetricExportInfoWithDefaults instantiates a new PrometheusMetricExportInfo object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PrometheusMetricExportInfo) GetClusterId added in v1.8.0 

func (o *PrometheusMetricExportInfo) GetClusterId() string

GetClusterId returns the ClusterId field value.

func (*PrometheusMetricExportInfo) GetStatus added in v1.8.0 

func (o *PrometheusMetricExportInfo) GetStatus() MetricExportStatusType

GetStatus returns the Status field value if set, zero value otherwise.

func (*PrometheusMetricExportInfo) GetTargets added in v1.8.0 

func (o *PrometheusMetricExportInfo) GetTargets() map[string]string

GetTargets returns the Targets field value if set, zero value otherwise.

func (*PrometheusMetricExportInfo) GetUserMessage added in v1.8.0 

func (o *PrometheusMetricExportInfo) GetUserMessage() string

GetUserMessage returns the UserMessage field value if set, zero value otherwise.

func (*PrometheusMetricExportInfo) SetClusterId added in v1.8.0 

func (o *PrometheusMetricExportInfo) SetClusterId(v string)

SetClusterId sets field value.

func (*PrometheusMetricExportInfo) SetStatus added in v1.8.0 

func (o *PrometheusMetricExportInfo) SetStatus(v MetricExportStatusType)

SetStatus gets a reference to the given MetricExportStatusType and assigns it to the Status field.

func (*PrometheusMetricExportInfo) SetTargets added in v1.8.0 

func (o *PrometheusMetricExportInfo) SetTargets(v map[string]string)

SetTargets gets a reference to the given map[string]string and assigns it to the Targets field.

func (*PrometheusMetricExportInfo) SetUserMessage added in v1.8.0 

func (o *PrometheusMetricExportInfo) SetUserMessage(v string)

SetUserMessage gets a reference to the given string and assigns it to the UserMessage field.

type QuantityUnitType 

type QuantityUnitType string

QuantityUnitType the model 'QuantityUnitType'. 

const (
	QUANTITYUNITTYPE_HOURS         QuantityUnitType = "HOURS"
	QUANTITYUNITTYPE_REQUEST_UNITS QuantityUnitType = "REQUEST_UNITS"
)

List of QuantityUnit.Type.

func NewQuantityUnitTypeFromValue 

func NewQuantityUnitTypeFromValue(v string) (*QuantityUnitType, error)

NewQuantityUnitTypeFromValue returns a pointer to a valid QuantityUnitType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (QuantityUnitType) IsValid 

func (v QuantityUnitType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (QuantityUnitType) Ptr 

func (v QuantityUnitType) Ptr() *QuantityUnitType

Ptr returns reference to QuantityUnit.Type value.

type Region 

type Region struct {
	// internal_dns is the internal DNS name of the cluster within the cloud provider's network. It is used to connect to the cluster with PrivateLink or VPC peering.
	InternalDns string `json:"internal_dns"`
	Name        string `json:"name"`
	// node_count will be 0 for Serverless clusters.
	NodeCount int32 `json:"node_count"`
	// primary is true only for the primary region in a Multi Region Serverless cluster.
	Primary *bool `json:"primary,omitempty"`
	// sql_dns is the DNS name of SQL interface of the cluster. It is used to connect to the cluster with IP allowlisting.
	SqlDns string `json:"sql_dns"`
	// ui_dns is the DNS name used when connecting to the DB Console for the cluster.
	UiDns string `json:"ui_dns"`
}

Region struct for Region.

func NewRegion 

func NewRegion(internalDns string, name string, nodeCount int32, sqlDns string, uiDns string) *Region

NewRegion instantiates a new Region object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRegionWithDefaults 

func NewRegionWithDefaults() *Region

NewRegionWithDefaults instantiates a new Region object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Region) GetInternalDns added in v0.3.3 

func (o *Region) GetInternalDns() string

GetInternalDns returns the InternalDns field value.

func (*Region) GetName 

func (o *Region) GetName() string

GetName returns the Name field value.

func (*Region) GetNodeCount 

func (o *Region) GetNodeCount() int32

GetNodeCount returns the NodeCount field value.

func (*Region) GetPrimary added in v0.4.3 

func (o *Region) GetPrimary() bool

GetPrimary returns the Primary field value if set, zero value otherwise.

func (*Region) GetSqlDns 

func (o *Region) GetSqlDns() string

GetSqlDns returns the SqlDns field value.

func (*Region) GetUiDns 

func (o *Region) GetUiDns() string

GetUiDns returns the UiDns field value.

func (*Region) SetInternalDns added in v0.3.3 

func (o *Region) SetInternalDns(v string)

SetInternalDns sets field value.

func (*Region) SetName 

func (o *Region) SetName(v string)

SetName sets field value.

func (*Region) SetNodeCount 

func (o *Region) SetNodeCount(v int32)

SetNodeCount sets field value.

func (*Region) SetPrimary added in v0.4.3 

func (o *Region) SetPrimary(v bool)

SetPrimary gets a reference to the given bool and assigns it to the Primary field.

func (*Region) SetSqlDns 

func (o *Region) SetSqlDns(v string)

SetSqlDns sets field value.

func (*Region) SetUiDns 

func (o *Region) SetUiDns(v string)

SetUiDns sets field value.

type RemovePrivateEndpointTrustedOwnerResponse added in v1.6.0 

type RemovePrivateEndpointTrustedOwnerResponse struct {
	TrustedOwner PrivateEndpointTrustedOwner `json:"trusted_owner"`
}

RemovePrivateEndpointTrustedOwnerResponse struct for RemovePrivateEndpointTrustedOwnerResponse.

func NewRemovePrivateEndpointTrustedOwnerResponse added in v1.6.0 

func NewRemovePrivateEndpointTrustedOwnerResponse(trustedOwner PrivateEndpointTrustedOwner) *RemovePrivateEndpointTrustedOwnerResponse

NewRemovePrivateEndpointTrustedOwnerResponse instantiates a new RemovePrivateEndpointTrustedOwnerResponse object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRemovePrivateEndpointTrustedOwnerResponseWithDefaults added in v1.6.0 

func NewRemovePrivateEndpointTrustedOwnerResponseWithDefaults() *RemovePrivateEndpointTrustedOwnerResponse

NewRemovePrivateEndpointTrustedOwnerResponseWithDefaults instantiates a new RemovePrivateEndpointTrustedOwnerResponse object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RemovePrivateEndpointTrustedOwnerResponse) GetTrustedOwner added in v1.6.0 

func (o *RemovePrivateEndpointTrustedOwnerResponse) GetTrustedOwner() PrivateEndpointTrustedOwner

GetTrustedOwner returns the TrustedOwner field value.

func (*RemovePrivateEndpointTrustedOwnerResponse) SetTrustedOwner added in v1.6.0 

func (o *RemovePrivateEndpointTrustedOwnerResponse) SetTrustedOwner(v PrivateEndpointTrustedOwner)

SetTrustedOwner sets field value.

type Resource added in v0.4.2 

type Resource struct {
	Id   *string          `json:"id,omitempty"`
	Type ResourceTypeType `json:"type"`
}

Resource struct for Resource.

func NewResource added in v0.4.2 

func NewResource(type_ ResourceTypeType) *Resource

NewResource instantiates a new Resource object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewResourceWithDefaults added in v0.4.4 

func NewResourceWithDefaults() *Resource

NewResourceWithDefaults instantiates a new Resource object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Resource) GetId added in v0.4.2 

func (o *Resource) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Resource) GetType added in v0.4.2 

func (o *Resource) GetType() ResourceTypeType

GetType returns the Type field value.

func (*Resource) SetId added in v0.4.2 

func (o *Resource) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Resource) SetType added in v0.4.2 

func (o *Resource) SetType(v ResourceTypeType)

SetType sets field value.

type ResourceTypeType added in v1.0.0 

type ResourceTypeType string

ResourceTypeType - ORGANIZATION: An organization. - CLUSTER: A cluster resource. - FOLDER: Limited Access: A folder resource. 

const (
	RESOURCETYPETYPE_ORGANIZATION ResourceTypeType = "ORGANIZATION"
	RESOURCETYPETYPE_CLUSTER      ResourceTypeType = "CLUSTER"
	RESOURCETYPETYPE_FOLDER       ResourceTypeType = "FOLDER"
)

List of ResourceType.Type.

func NewResourceTypeTypeFromValue added in v1.0.0 

func NewResourceTypeTypeFromValue(v string) (*ResourceTypeType, error)

NewResourceTypeTypeFromValue returns a pointer to a valid ResourceTypeType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ResourceTypeType) IsValid added in v1.0.0 

func (v ResourceTypeType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ResourceTypeType) Ptr added in v1.0.0 

func (v ResourceTypeType) Ptr() *ResourceTypeType

Ptr returns reference to ResourceType.Type value.

type SQLUser 

type SQLUser struct {
	Name string `json:"name"`
}

SQLUser struct for SQLUser.

func NewSQLUser 

func NewSQLUser(name string) *SQLUser

NewSQLUser instantiates a new SQLUser object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSQLUserWithDefaults 

func NewSQLUserWithDefaults() *SQLUser

NewSQLUserWithDefaults instantiates a new SQLUser object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SQLUser) GetName 

func (o *SQLUser) GetName() string

GetName returns the Name field value.

func (*SQLUser) SetName 

func (o *SQLUser) SetName(v string)

SetName sets field value.

type ScimAuthenticationScheme added in v1.1.0 

type ScimAuthenticationScheme struct {
	Description      *string `json:"description,omitempty"`
	DocumentationUri *string `json:"documentationUri,omitempty"`
	Name             *string `json:"name,omitempty"`
	Primary          *bool   `json:"primary,omitempty"`
	SpecUri          *string `json:"specUri,omitempty"`
	Type             *string `json:"type,omitempty"`
}

ScimAuthenticationScheme struct for ScimAuthenticationScheme.

func NewScimAuthenticationScheme added in v1.1.0 

func NewScimAuthenticationScheme() *ScimAuthenticationScheme

NewScimAuthenticationScheme instantiates a new ScimAuthenticationScheme object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimAuthenticationScheme) GetDescription added in v1.1.0 

func (o *ScimAuthenticationScheme) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) GetDocumentationUri added in v1.1.0 

func (o *ScimAuthenticationScheme) GetDocumentationUri() string

GetDocumentationUri returns the DocumentationUri field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) GetName added in v1.1.0 

func (o *ScimAuthenticationScheme) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) GetPrimary added in v1.1.0 

func (o *ScimAuthenticationScheme) GetPrimary() bool

GetPrimary returns the Primary field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) GetSpecUri added in v1.1.0 

func (o *ScimAuthenticationScheme) GetSpecUri() string

GetSpecUri returns the SpecUri field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) GetType added in v1.1.0 

func (o *ScimAuthenticationScheme) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ScimAuthenticationScheme) SetDescription added in v1.1.0 

func (o *ScimAuthenticationScheme) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ScimAuthenticationScheme) SetDocumentationUri added in v1.1.0 

func (o *ScimAuthenticationScheme) SetDocumentationUri(v string)

SetDocumentationUri gets a reference to the given string and assigns it to the DocumentationUri field.

func (*ScimAuthenticationScheme) SetName added in v1.1.0 

func (o *ScimAuthenticationScheme) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*ScimAuthenticationScheme) SetPrimary added in v1.1.0 

func (o *ScimAuthenticationScheme) SetPrimary(v bool)

SetPrimary gets a reference to the given bool and assigns it to the Primary field.

func (*ScimAuthenticationScheme) SetSpecUri added in v1.1.0 

func (o *ScimAuthenticationScheme) SetSpecUri(v string)

SetSpecUri gets a reference to the given string and assigns it to the SpecUri field.

func (*ScimAuthenticationScheme) SetType added in v1.1.0 

func (o *ScimAuthenticationScheme) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

type ScimBulkSupport added in v1.1.0 

type ScimBulkSupport struct {
	MaxOperations  *int32 `json:"maxOperations,omitempty"`
	MaxPayloadSize *int32 `json:"maxPayloadSize,omitempty"`
	Supported      *bool  `json:"supported,omitempty"`
}

ScimBulkSupport struct for ScimBulkSupport.

func NewScimBulkSupport added in v1.1.0 

func NewScimBulkSupport() *ScimBulkSupport

NewScimBulkSupport instantiates a new ScimBulkSupport object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimBulkSupport) GetMaxOperations added in v1.1.0 

func (o *ScimBulkSupport) GetMaxOperations() int32

GetMaxOperations returns the MaxOperations field value if set, zero value otherwise.

func (*ScimBulkSupport) GetMaxPayloadSize added in v1.1.0 

func (o *ScimBulkSupport) GetMaxPayloadSize() int32

GetMaxPayloadSize returns the MaxPayloadSize field value if set, zero value otherwise.

func (*ScimBulkSupport) GetSupported added in v1.1.0 

func (o *ScimBulkSupport) GetSupported() bool

GetSupported returns the Supported field value if set, zero value otherwise.

func (*ScimBulkSupport) SetMaxOperations added in v1.1.0 

func (o *ScimBulkSupport) SetMaxOperations(v int32)

SetMaxOperations gets a reference to the given int32 and assigns it to the MaxOperations field.

func (*ScimBulkSupport) SetMaxPayloadSize added in v1.1.0 

func (o *ScimBulkSupport) SetMaxPayloadSize(v int32)

SetMaxPayloadSize gets a reference to the given int32 and assigns it to the MaxPayloadSize field.

func (*ScimBulkSupport) SetSupported added in v1.1.0 

func (o *ScimBulkSupport) SetSupported(v bool)

SetSupported gets a reference to the given bool and assigns it to the Supported field.

type ScimChangePasswordSupport added in v1.1.0 

type ScimChangePasswordSupport struct {
	Supported *bool `json:"supported,omitempty"`
}

ScimChangePasswordSupport struct for ScimChangePasswordSupport.

func NewScimChangePasswordSupport added in v1.1.0 

func NewScimChangePasswordSupport() *ScimChangePasswordSupport

NewScimChangePasswordSupport instantiates a new ScimChangePasswordSupport object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimChangePasswordSupport) GetSupported added in v1.1.0 

func (o *ScimChangePasswordSupport) GetSupported() bool

GetSupported returns the Supported field value if set, zero value otherwise.

func (*ScimChangePasswordSupport) SetSupported added in v1.1.0 

func (o *ScimChangePasswordSupport) SetSupported(v bool)

SetSupported gets a reference to the given bool and assigns it to the Supported field.

type ScimEmail added in v1.1.0 

type ScimEmail struct {
	Display *string `json:"display,omitempty"`
	Primary bool    `json:"primary"`
	Type    *string `json:"type,omitempty"`
	Value   string  `json:"value"`
}

ScimEmail struct for ScimEmail.

func NewScimEmail added in v1.1.0 

func NewScimEmail(primary bool, value string) *ScimEmail

NewScimEmail instantiates a new ScimEmail object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewScimEmailWithDefaults added in v1.1.0 

func NewScimEmailWithDefaults() *ScimEmail

NewScimEmailWithDefaults instantiates a new ScimEmail object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ScimEmail) GetDisplay added in v1.1.0 

func (o *ScimEmail) GetDisplay() string

GetDisplay returns the Display field value if set, zero value otherwise.

func (*ScimEmail) GetPrimary added in v1.1.0 

func (o *ScimEmail) GetPrimary() bool

GetPrimary returns the Primary field value.

func (*ScimEmail) GetType added in v1.1.0 

func (o *ScimEmail) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ScimEmail) GetValue added in v1.1.0 

func (o *ScimEmail) GetValue() string

GetValue returns the Value field value.

func (*ScimEmail) SetDisplay added in v1.1.0 

func (o *ScimEmail) SetDisplay(v string)

SetDisplay gets a reference to the given string and assigns it to the Display field.

func (*ScimEmail) SetPrimary added in v1.1.0 

func (o *ScimEmail) SetPrimary(v bool)

SetPrimary sets field value.

func (*ScimEmail) SetType added in v1.1.0 

func (o *ScimEmail) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*ScimEmail) SetValue added in v1.1.0 

func (o *ScimEmail) SetValue(v string)

SetValue sets field value.

type ScimEtagSupport added in v1.1.0 

type ScimEtagSupport struct {
	MaxResults *int32 `json:"maxResults,omitempty"`
	Supported  *bool  `json:"supported,omitempty"`
}

ScimEtagSupport struct for ScimEtagSupport.

func NewScimEtagSupport added in v1.1.0 

func NewScimEtagSupport() *ScimEtagSupport

NewScimEtagSupport instantiates a new ScimEtagSupport object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimEtagSupport) GetMaxResults added in v1.1.0 

func (o *ScimEtagSupport) GetMaxResults() int32

GetMaxResults returns the MaxResults field value if set, zero value otherwise.

func (*ScimEtagSupport) GetSupported added in v1.1.0 

func (o *ScimEtagSupport) GetSupported() bool

GetSupported returns the Supported field value if set, zero value otherwise.

func (*ScimEtagSupport) SetMaxResults added in v1.1.0 

func (o *ScimEtagSupport) SetMaxResults(v int32)

SetMaxResults gets a reference to the given int32 and assigns it to the MaxResults field.

func (*ScimEtagSupport) SetSupported added in v1.1.0 

func (o *ScimEtagSupport) SetSupported(v bool)

SetSupported gets a reference to the given bool and assigns it to the Supported field.

type ScimFilterSupport added in v1.1.0 

type ScimFilterSupport struct {
	MaxResults *int32 `json:"maxResults,omitempty"`
	Supported  *bool  `json:"supported,omitempty"`
}

ScimFilterSupport struct for ScimFilterSupport.

func NewScimFilterSupport added in v1.1.0 

func NewScimFilterSupport() *ScimFilterSupport

NewScimFilterSupport instantiates a new ScimFilterSupport object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimFilterSupport) GetMaxResults added in v1.1.0 

func (o *ScimFilterSupport) GetMaxResults() int32

GetMaxResults returns the MaxResults field value if set, zero value otherwise.

func (*ScimFilterSupport) GetSupported added in v1.1.0 

func (o *ScimFilterSupport) GetSupported() bool

GetSupported returns the Supported field value if set, zero value otherwise.

func (*ScimFilterSupport) SetMaxResults added in v1.1.0 

func (o *ScimFilterSupport) SetMaxResults(v int32)

SetMaxResults gets a reference to the given int32 and assigns it to the MaxResults field.

func (*ScimFilterSupport) SetSupported added in v1.1.0 

func (o *ScimFilterSupport) SetSupported(v bool)

SetSupported gets a reference to the given bool and assigns it to the Supported field.

type ScimGroup added in v1.1.0 

type ScimGroup struct {
	DisplayName *string         `json:"displayName,omitempty"`
	ExternalId  *string         `json:"externalId,omitempty"`
	Id          *string         `json:"id,omitempty"`
	Members     *[]ScimResource `json:"members,omitempty"`
	Meta        *ScimMetadata   `json:"meta,omitempty"`
	Schemas     *[]string       `json:"schemas,omitempty"`
}

ScimGroup struct for ScimGroup.

func NewScimGroup added in v1.1.0 

func NewScimGroup() *ScimGroup

NewScimGroup instantiates a new ScimGroup object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimGroup) GetDisplayName added in v1.1.0 

func (o *ScimGroup) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise.

func (*ScimGroup) GetExternalId added in v1.1.0 

func (o *ScimGroup) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*ScimGroup) GetId added in v1.1.0 

func (o *ScimGroup) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ScimGroup) GetMembers added in v1.1.0 

func (o *ScimGroup) GetMembers() []ScimResource

GetMembers returns the Members field value if set, zero value otherwise.

func (*ScimGroup) GetMeta added in v1.1.0 

func (o *ScimGroup) GetMeta() ScimMetadata

GetMeta returns the Meta field value if set, zero value otherwise.

func (*ScimGroup) GetSchemas added in v1.1.0 

func (o *ScimGroup) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*ScimGroup) SetDisplayName added in v1.1.0 

func (o *ScimGroup) SetDisplayName(v string)

SetDisplayName gets a reference to the given string and assigns it to the DisplayName field.

func (*ScimGroup) SetExternalId added in v1.1.0 

func (o *ScimGroup) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*ScimGroup) SetId added in v1.1.0 

func (o *ScimGroup) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ScimGroup) SetMembers added in v1.1.0 

func (o *ScimGroup) SetMembers(v []ScimResource)

SetMembers gets a reference to the given []ScimResource and assigns it to the Members field.

func (*ScimGroup) SetMeta added in v1.1.0 

func (o *ScimGroup) SetMeta(v ScimMetadata)

SetMeta gets a reference to the given ScimMetadata and assigns it to the Meta field.

func (*ScimGroup) SetSchemas added in v1.1.0 

func (o *ScimGroup) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

type ScimMetadata added in v1.1.0 

type ScimMetadata struct {
	Created      *string `json:"created,omitempty"`
	LastModified *string `json:"lastModified,omitempty"`
	Location     *string `json:"location,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
}

ScimMetadata struct for ScimMetadata.

func NewScimMetadata added in v1.1.0 

func NewScimMetadata() *ScimMetadata

NewScimMetadata instantiates a new ScimMetadata object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimMetadata) GetCreated added in v1.1.0 

func (o *ScimMetadata) GetCreated() string

GetCreated returns the Created field value if set, zero value otherwise.

func (*ScimMetadata) GetLastModified added in v1.1.0 

func (o *ScimMetadata) GetLastModified() string

GetLastModified returns the LastModified field value if set, zero value otherwise.

func (*ScimMetadata) GetLocation added in v1.1.0 

func (o *ScimMetadata) GetLocation() string

GetLocation returns the Location field value if set, zero value otherwise.

func (*ScimMetadata) GetResourceType added in v1.1.0 

func (o *ScimMetadata) GetResourceType() string

GetResourceType returns the ResourceType field value if set, zero value otherwise.

func (*ScimMetadata) SetCreated added in v1.1.0 

func (o *ScimMetadata) SetCreated(v string)

SetCreated gets a reference to the given string and assigns it to the Created field.

func (*ScimMetadata) SetLastModified added in v1.1.0 

func (o *ScimMetadata) SetLastModified(v string)

SetLastModified gets a reference to the given string and assigns it to the LastModified field.

func (*ScimMetadata) SetLocation added in v1.1.0 

func (o *ScimMetadata) SetLocation(v string)

SetLocation gets a reference to the given string and assigns it to the Location field.

func (*ScimMetadata) SetResourceType added in v1.1.0 

func (o *ScimMetadata) SetResourceType(v string)

SetResourceType gets a reference to the given string and assigns it to the ResourceType field.

type ScimName added in v1.1.0 

type ScimName struct {
	FamilyName *string `json:"familyName,omitempty"`
	GivenName  *string `json:"givenName,omitempty"`
}

ScimName struct for ScimName.

func NewScimName added in v1.1.0 

func NewScimName() *ScimName

NewScimName instantiates a new ScimName object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimName) GetFamilyName added in v1.1.0 

func (o *ScimName) GetFamilyName() string

GetFamilyName returns the FamilyName field value if set, zero value otherwise.

func (*ScimName) GetGivenName added in v1.1.0 

func (o *ScimName) GetGivenName() string

GetGivenName returns the GivenName field value if set, zero value otherwise.

func (*ScimName) SetFamilyName added in v1.1.0 

func (o *ScimName) SetFamilyName(v string)

SetFamilyName gets a reference to the given string and assigns it to the FamilyName field.

func (*ScimName) SetGivenName added in v1.1.0 

func (o *ScimName) SetGivenName(v string)

SetGivenName gets a reference to the given string and assigns it to the GivenName field.

type ScimResource added in v1.1.0 

type ScimResource struct {
	Display *string `json:"display,omitempty"`
	Ref     *string `json:"ref,omitempty"`
	Type    *string `json:"type,omitempty"`
	Value   *string `json:"value,omitempty"`
}

ScimResource struct for ScimResource.

func NewScimResource added in v1.1.0 

func NewScimResource() *ScimResource

NewScimResource instantiates a new ScimResource object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimResource) GetDisplay added in v1.1.0 

func (o *ScimResource) GetDisplay() string

GetDisplay returns the Display field value if set, zero value otherwise.

func (*ScimResource) GetRef added in v1.1.0 

func (o *ScimResource) GetRef() string

GetRef returns the Ref field value if set, zero value otherwise.

func (*ScimResource) GetType added in v1.1.0 

func (o *ScimResource) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ScimResource) GetValue added in v1.1.0 

func (o *ScimResource) GetValue() string

GetValue returns the Value field value if set, zero value otherwise.

func (*ScimResource) SetDisplay added in v1.1.0 

func (o *ScimResource) SetDisplay(v string)

SetDisplay gets a reference to the given string and assigns it to the Display field.

func (*ScimResource) SetRef added in v1.1.0 

func (o *ScimResource) SetRef(v string)

SetRef gets a reference to the given string and assigns it to the Ref field.

func (*ScimResource) SetType added in v1.1.0 

func (o *ScimResource) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*ScimResource) SetValue added in v1.1.0 

func (o *ScimResource) SetValue(v string)

SetValue gets a reference to the given string and assigns it to the Value field.

type ScimResourceType added in v1.1.0 

type ScimResourceType struct {
	Description *string       `json:"description,omitempty"`
	Endpoint    *string       `json:"endpoint,omitempty"`
	Id          *string       `json:"id,omitempty"`
	Meta        *ScimMetadata `json:"meta,omitempty"`
	Name        *string       `json:"name,omitempty"`
	Schema      *string       `json:"schema,omitempty"`
	Schemas     *[]string     `json:"schemas,omitempty"`
}

ScimResourceType struct for ScimResourceType.

func NewScimResourceType added in v1.1.0 

func NewScimResourceType() *ScimResourceType

NewScimResourceType instantiates a new ScimResourceType object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimResourceType) GetDescription added in v1.1.0 

func (o *ScimResourceType) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ScimResourceType) GetEndpoint added in v1.1.0 

func (o *ScimResourceType) GetEndpoint() string

GetEndpoint returns the Endpoint field value if set, zero value otherwise.

func (*ScimResourceType) GetId added in v1.1.0 

func (o *ScimResourceType) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ScimResourceType) GetMeta added in v1.1.0 

func (o *ScimResourceType) GetMeta() ScimMetadata

GetMeta returns the Meta field value if set, zero value otherwise.

func (*ScimResourceType) GetName added in v1.1.0 

func (o *ScimResourceType) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ScimResourceType) GetSchema added in v1.1.0 

func (o *ScimResourceType) GetSchema() string

GetSchema returns the Schema field value if set, zero value otherwise.

func (*ScimResourceType) GetSchemas added in v1.1.0 

func (o *ScimResourceType) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*ScimResourceType) SetDescription added in v1.1.0 

func (o *ScimResourceType) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ScimResourceType) SetEndpoint added in v1.1.0 

func (o *ScimResourceType) SetEndpoint(v string)

SetEndpoint gets a reference to the given string and assigns it to the Endpoint field.

func (*ScimResourceType) SetId added in v1.1.0 

func (o *ScimResourceType) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ScimResourceType) SetMeta added in v1.1.0 

func (o *ScimResourceType) SetMeta(v ScimMetadata)

SetMeta gets a reference to the given ScimMetadata and assigns it to the Meta field.

func (*ScimResourceType) SetName added in v1.1.0 

func (o *ScimResourceType) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*ScimResourceType) SetSchema added in v1.1.0 

func (o *ScimResourceType) SetSchema(v string)

SetSchema gets a reference to the given string and assigns it to the Schema field.

func (*ScimResourceType) SetSchemas added in v1.1.0 

func (o *ScimResourceType) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

type ScimSchema added in v1.1.0 

type ScimSchema struct {
	Attributes  *[]ScimSchemaAttribute `json:"attributes,omitempty"`
	Description *string                `json:"description,omitempty"`
	Id          *string                `json:"id,omitempty"`
	Meta        *ScimMetadata          `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

ScimSchema struct for ScimSchema.

func NewScimSchema added in v1.1.0 

func NewScimSchema() *ScimSchema

NewScimSchema instantiates a new ScimSchema object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimSchema) GetAttributes added in v1.1.0 

func (o *ScimSchema) GetAttributes() []ScimSchemaAttribute

GetAttributes returns the Attributes field value if set, zero value otherwise.

func (*ScimSchema) GetDescription added in v1.1.0 

func (o *ScimSchema) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ScimSchema) GetId added in v1.1.0 

func (o *ScimSchema) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ScimSchema) GetMeta added in v1.1.0 

func (o *ScimSchema) GetMeta() ScimMetadata

GetMeta returns the Meta field value if set, zero value otherwise.

func (*ScimSchema) GetName added in v1.1.0 

func (o *ScimSchema) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ScimSchema) SetAttributes added in v1.1.0 

func (o *ScimSchema) SetAttributes(v []ScimSchemaAttribute)

SetAttributes gets a reference to the given []ScimSchemaAttribute and assigns it to the Attributes field.

func (*ScimSchema) SetDescription added in v1.1.0 

func (o *ScimSchema) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ScimSchema) SetId added in v1.1.0 

func (o *ScimSchema) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ScimSchema) SetMeta added in v1.1.0 

func (o *ScimSchema) SetMeta(v ScimMetadata)

SetMeta gets a reference to the given ScimMetadata and assigns it to the Meta field.

func (*ScimSchema) SetName added in v1.1.0 

func (o *ScimSchema) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type ScimSchemaAttribute added in v1.1.0 

type ScimSchemaAttribute struct {
	CanonicalValues *[]string              `json:"canonicalValues,omitempty"`
	CaseExact       *bool                  `json:"caseExact,omitempty"`
	Description     *string                `json:"description,omitempty"`
	MultiValued     *bool                  `json:"multiValued,omitempty"`
	Mutability      *string                `json:"mutability,omitempty"`
	Name            *string                `json:"name,omitempty"`
	ReferenceTypes  *[]string              `json:"referenceTypes,omitempty"`
	Required        *bool                  `json:"required,omitempty"`
	Returned        *string                `json:"returned,omitempty"`
	SubAttributes   *[]ScimSchemaAttribute `json:"subAttributes,omitempty"`
	Type            *string                `json:"type,omitempty"`
	Uniqueness      *string                `json:"uniqueness,omitempty"`
}

ScimSchemaAttribute struct for ScimSchemaAttribute.

func NewScimSchemaAttribute added in v1.1.0 

func NewScimSchemaAttribute() *ScimSchemaAttribute

NewScimSchemaAttribute instantiates a new ScimSchemaAttribute object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimSchemaAttribute) GetCanonicalValues added in v1.1.0 

func (o *ScimSchemaAttribute) GetCanonicalValues() []string

GetCanonicalValues returns the CanonicalValues field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetCaseExact added in v1.1.0 

func (o *ScimSchemaAttribute) GetCaseExact() bool

GetCaseExact returns the CaseExact field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetDescription added in v1.1.0 

func (o *ScimSchemaAttribute) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetMultiValued added in v1.1.0 

func (o *ScimSchemaAttribute) GetMultiValued() bool

GetMultiValued returns the MultiValued field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetMutability added in v1.1.0 

func (o *ScimSchemaAttribute) GetMutability() string

GetMutability returns the Mutability field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetName added in v1.1.0 

func (o *ScimSchemaAttribute) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetReferenceTypes added in v1.1.0 

func (o *ScimSchemaAttribute) GetReferenceTypes() []string

GetReferenceTypes returns the ReferenceTypes field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetRequired added in v1.1.0 

func (o *ScimSchemaAttribute) GetRequired() bool

GetRequired returns the Required field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetReturned added in v1.1.0 

func (o *ScimSchemaAttribute) GetReturned() string

GetReturned returns the Returned field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetSubAttributes added in v1.1.0 

func (o *ScimSchemaAttribute) GetSubAttributes() []ScimSchemaAttribute

GetSubAttributes returns the SubAttributes field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetType added in v1.1.0 

func (o *ScimSchemaAttribute) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ScimSchemaAttribute) GetUniqueness added in v1.1.0 

func (o *ScimSchemaAttribute) GetUniqueness() string

GetUniqueness returns the Uniqueness field value if set, zero value otherwise.

func (*ScimSchemaAttribute) SetCanonicalValues added in v1.1.0 

func (o *ScimSchemaAttribute) SetCanonicalValues(v []string)

SetCanonicalValues gets a reference to the given []string and assigns it to the CanonicalValues field.

func (*ScimSchemaAttribute) SetCaseExact added in v1.1.0 

func (o *ScimSchemaAttribute) SetCaseExact(v bool)

SetCaseExact gets a reference to the given bool and assigns it to the CaseExact field.

func (*ScimSchemaAttribute) SetDescription added in v1.1.0 

func (o *ScimSchemaAttribute) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ScimSchemaAttribute) SetMultiValued added in v1.1.0 

func (o *ScimSchemaAttribute) SetMultiValued(v bool)

SetMultiValued gets a reference to the given bool and assigns it to the MultiValued field.

func (*ScimSchemaAttribute) SetMutability added in v1.1.0 

func (o *ScimSchemaAttribute) SetMutability(v string)

SetMutability gets a reference to the given string and assigns it to the Mutability field.

func (*ScimSchemaAttribute) SetName added in v1.1.0 

func (o *ScimSchemaAttribute) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*ScimSchemaAttribute) SetReferenceTypes added in v1.1.0 

func (o *ScimSchemaAttribute) SetReferenceTypes(v []string)

SetReferenceTypes gets a reference to the given []string and assigns it to the ReferenceTypes field.

func (*ScimSchemaAttribute) SetRequired added in v1.1.0 

func (o *ScimSchemaAttribute) SetRequired(v bool)

SetRequired gets a reference to the given bool and assigns it to the Required field.

func (*ScimSchemaAttribute) SetReturned added in v1.1.0 

func (o *ScimSchemaAttribute) SetReturned(v string)

SetReturned gets a reference to the given string and assigns it to the Returned field.

func (*ScimSchemaAttribute) SetSubAttributes added in v1.1.0 

func (o *ScimSchemaAttribute) SetSubAttributes(v []ScimSchemaAttribute)

SetSubAttributes gets a reference to the given []ScimSchemaAttribute and assigns it to the SubAttributes field.

func (*ScimSchemaAttribute) SetType added in v1.1.0 

func (o *ScimSchemaAttribute) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*ScimSchemaAttribute) SetUniqueness added in v1.1.0 

func (o *ScimSchemaAttribute) SetUniqueness(v string)

SetUniqueness gets a reference to the given string and assigns it to the Uniqueness field.

type ScimSortSupport added in v1.1.0 

type ScimSortSupport struct {
	Supported *bool `json:"supported,omitempty"`
}

ScimSortSupport struct for ScimSortSupport.

func NewScimSortSupport added in v1.1.0 

func NewScimSortSupport() *ScimSortSupport

NewScimSortSupport instantiates a new ScimSortSupport object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimSortSupport) GetSupported added in v1.1.0 

func (o *ScimSortSupport) GetSupported() bool

GetSupported returns the Supported field value if set, zero value otherwise.

func (*ScimSortSupport) SetSupported added in v1.1.0 

func (o *ScimSortSupport) SetSupported(v bool)

SetSupported gets a reference to the given bool and assigns it to the Supported field.

type ScimUser added in v1.1.0 

type ScimUser struct {
	Active      *bool           `json:"active,omitempty"`
	DisplayName *string         `json:"displayName,omitempty"`
	Emails      *[]ScimEmail    `json:"emails,omitempty"`
	ExternalId  *string         `json:"externalId,omitempty"`
	Groups      *[]ScimResource `json:"groups,omitempty"`
	Id          *string         `json:"id,omitempty"`
	Meta        *ScimMetadata   `json:"meta,omitempty"`
	Name        *ScimName       `json:"name,omitempty"`
	Schemas     *[]string       `json:"schemas,omitempty"`
	UserName    *string         `json:"userName,omitempty"`
}

ScimUser struct for ScimUser.

func NewScimUser added in v1.1.0 

func NewScimUser() *ScimUser

NewScimUser instantiates a new ScimUser object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ScimUser) GetActive added in v1.1.0 

func (o *ScimUser) GetActive() bool

GetActive returns the Active field value if set, zero value otherwise.

func (*ScimUser) GetDisplayName added in v1.1.0 

func (o *ScimUser) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise.

func (*ScimUser) GetEmails added in v1.1.0 

func (o *ScimUser) GetEmails() []ScimEmail

GetEmails returns the Emails field value if set, zero value otherwise.

func (*ScimUser) GetExternalId added in v1.1.0 

func (o *ScimUser) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*ScimUser) GetGroups added in v1.1.0 

func (o *ScimUser) GetGroups() []ScimResource

GetGroups returns the Groups field value if set, zero value otherwise.

func (*ScimUser) GetId added in v1.1.0 

func (o *ScimUser) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ScimUser) GetMeta added in v1.1.0 

func (o *ScimUser) GetMeta() ScimMetadata

GetMeta returns the Meta field value if set, zero value otherwise.

func (*ScimUser) GetName added in v1.1.0 

func (o *ScimUser) GetName() ScimName

GetName returns the Name field value if set, zero value otherwise.

func (*ScimUser) GetSchemas added in v1.1.0 

func (o *ScimUser) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*ScimUser) GetUserName added in v1.1.0 

func (o *ScimUser) GetUserName() string

GetUserName returns the UserName field value if set, zero value otherwise.

func (*ScimUser) SetActive added in v1.1.0 

func (o *ScimUser) SetActive(v bool)

SetActive gets a reference to the given bool and assigns it to the Active field.

func (*ScimUser) SetDisplayName added in v1.1.0 

func (o *ScimUser) SetDisplayName(v string)

SetDisplayName gets a reference to the given string and assigns it to the DisplayName field.

func (*ScimUser) SetEmails added in v1.1.0 

func (o *ScimUser) SetEmails(v []ScimEmail)

SetEmails gets a reference to the given []ScimEmail and assigns it to the Emails field.

func (*ScimUser) SetExternalId added in v1.1.0 

func (o *ScimUser) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*ScimUser) SetGroups added in v1.1.0 

func (o *ScimUser) SetGroups(v []ScimResource)

SetGroups gets a reference to the given []ScimResource and assigns it to the Groups field.

func (*ScimUser) SetId added in v1.1.0 

func (o *ScimUser) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*ScimUser) SetMeta added in v1.1.0 

func (o *ScimUser) SetMeta(v ScimMetadata)

SetMeta gets a reference to the given ScimMetadata and assigns it to the Meta field.

func (*ScimUser) SetName added in v1.1.0 

func (o *ScimUser) SetName(v ScimName)

SetName gets a reference to the given ScimName and assigns it to the Name field.

func (*ScimUser) SetSchemas added in v1.1.0 

func (o *ScimUser) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*ScimUser) SetUserName added in v1.1.0 

func (o *ScimUser) SetUserName(v string)

SetUserName gets a reference to the given string and assigns it to the UserName field.

type ServerlessClusterConfig 

type ServerlessClusterConfig struct {
	// routing_id is used to identify the cluster in a connection string.
	RoutingId string `json:"routing_id"`
	// spend_limit is the maximum monthly charge for a cluster, in US cents. We recommend using usage_limits instead, since spend_limit will be deprecated in the future.
	SpendLimit  *int32       `json:"spend_limit,omitempty"`
	UsageLimits *UsageLimits `json:"usage_limits,omitempty"`
}

ServerlessClusterConfig struct for ServerlessClusterConfig.

func NewServerlessClusterConfig 

func NewServerlessClusterConfig(routingId string) *ServerlessClusterConfig

NewServerlessClusterConfig instantiates a new ServerlessClusterConfig object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewServerlessClusterConfigWithDefaults 

func NewServerlessClusterConfigWithDefaults() *ServerlessClusterConfig

NewServerlessClusterConfigWithDefaults instantiates a new ServerlessClusterConfig object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ServerlessClusterConfig) GetRoutingId 

func (o *ServerlessClusterConfig) GetRoutingId() string

GetRoutingId returns the RoutingId field value.

func (*ServerlessClusterConfig) GetSpendLimit 

func (o *ServerlessClusterConfig) GetSpendLimit() int32

GetSpendLimit returns the SpendLimit field value if set, zero value otherwise.

func (*ServerlessClusterConfig) GetUsageLimits added in v1.0.0 

func (o *ServerlessClusterConfig) GetUsageLimits() UsageLimits

GetUsageLimits returns the UsageLimits field value if set, zero value otherwise.

func (*ServerlessClusterConfig) SetRoutingId 

func (o *ServerlessClusterConfig) SetRoutingId(v string)

SetRoutingId sets field value.

func (*ServerlessClusterConfig) SetSpendLimit 

func (o *ServerlessClusterConfig) SetSpendLimit(v int32)

SetSpendLimit gets a reference to the given int32 and assigns it to the SpendLimit field.

func (*ServerlessClusterConfig) SetUsageLimits added in v1.0.0 

func (o *ServerlessClusterConfig) SetUsageLimits(v UsageLimits)

SetUsageLimits gets a reference to the given UsageLimits and assigns it to the UsageLimits field.

type ServerlessClusterCreateSpecification 

type ServerlessClusterCreateSpecification struct {
	// Preview: Specify which region should be made the primary region. This is only applicable to multi-region Serverless clusters. This field is required if you create the cluster in more than one region.
	PrimaryRegion *string `json:"primary_region,omitempty"`
	// Region values should match the cloud provider's zone code. For example, for Oregon, set region_name to \"us-west2\" for GCP and \"us-west-2\" for AWS.
	Regions []string `json:"regions"`
	// spend_limit is the maximum monthly charge for a cluster, in US cents. We recommend using usage_limits instead, since spend_limit will be deprecated in the future.
	SpendLimit  *int32       `json:"spend_limit,omitempty"`
	UsageLimits *UsageLimits `json:"usage_limits,omitempty"`
	// WithEmptyIPAllowlist creates a cluster with no entries in the IP Allowlist. By default, Serverless clusters have one IP allowlist entry that opens the cluster to any IP. Set this property to true to ensure the cluster is closed to public traffic by default.
	WithEmptyIpAllowlist *bool `json:"with_empty_ip_allowlist,omitempty"`
}

ServerlessClusterCreateSpecification struct for ServerlessClusterCreateSpecification.

func NewServerlessClusterCreateSpecification 

func NewServerlessClusterCreateSpecification(regions []string) *ServerlessClusterCreateSpecification

NewServerlessClusterCreateSpecification instantiates a new ServerlessClusterCreateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewServerlessClusterCreateSpecificationWithDefaults 

func NewServerlessClusterCreateSpecificationWithDefaults() *ServerlessClusterCreateSpecification

NewServerlessClusterCreateSpecificationWithDefaults instantiates a new ServerlessClusterCreateSpecification object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ServerlessClusterCreateSpecification) GetPrimaryRegion added in v0.4.1 

func (o *ServerlessClusterCreateSpecification) GetPrimaryRegion() string

GetPrimaryRegion returns the PrimaryRegion field value if set, zero value otherwise.

func (*ServerlessClusterCreateSpecification) GetRegions 

func (o *ServerlessClusterCreateSpecification) GetRegions() []string

GetRegions returns the Regions field value.

func (*ServerlessClusterCreateSpecification) GetSpendLimit 

func (o *ServerlessClusterCreateSpecification) GetSpendLimit() int32

GetSpendLimit returns the SpendLimit field value if set, zero value otherwise.

func (*ServerlessClusterCreateSpecification) GetUsageLimits added in v1.0.0 

func (o *ServerlessClusterCreateSpecification) GetUsageLimits() UsageLimits

GetUsageLimits returns the UsageLimits field value if set, zero value otherwise.

func (*ServerlessClusterCreateSpecification) GetWithEmptyIpAllowlist added in v1.4.0 

func (o *ServerlessClusterCreateSpecification) GetWithEmptyIpAllowlist() bool

GetWithEmptyIpAllowlist returns the WithEmptyIpAllowlist field value if set, zero value otherwise.

func (*ServerlessClusterCreateSpecification) SetPrimaryRegion added in v0.4.1 

func (o *ServerlessClusterCreateSpecification) SetPrimaryRegion(v string)

SetPrimaryRegion gets a reference to the given string and assigns it to the PrimaryRegion field.

func (*ServerlessClusterCreateSpecification) SetRegions 

func (o *ServerlessClusterCreateSpecification) SetRegions(v []string)

SetRegions sets field value.

func (*ServerlessClusterCreateSpecification) SetSpendLimit 

func (o *ServerlessClusterCreateSpecification) SetSpendLimit(v int32)

SetSpendLimit gets a reference to the given int32 and assigns it to the SpendLimit field.

func (*ServerlessClusterCreateSpecification) SetUsageLimits added in v1.0.0 

func (o *ServerlessClusterCreateSpecification) SetUsageLimits(v UsageLimits)

SetUsageLimits gets a reference to the given UsageLimits and assigns it to the UsageLimits field.

func (*ServerlessClusterCreateSpecification) SetWithEmptyIpAllowlist added in v1.4.0 

func (o *ServerlessClusterCreateSpecification) SetWithEmptyIpAllowlist(v bool)

SetWithEmptyIpAllowlist gets a reference to the given bool and assigns it to the WithEmptyIpAllowlist field.

type ServerlessClusterUpdateSpecification 

type ServerlessClusterUpdateSpecification struct {
	// Specify which region should be made the primary region. This is only applicable to multi-region Serverless clusters. This field is required if the regions field contains more than one region.
	PrimaryRegion *string `json:"primary_region,omitempty"`
	// Region values should match the cloud provider's zone code. For example, for Oregon, set region_name to \"us-west2\" for GCP and \"us-west-2\" for AWS. If this field is provided, the cluster's regions will be changed to match this list. Regions cannot currently be removed.
	Regions *[]string `json:"regions,omitempty"`
	// spend_limit is the maximum monthly charge for a cluster, in US cents. We recommend using usage_limits instead, since spend_limit will be deprecated in the future.
	SpendLimit  *int32       `json:"spend_limit,omitempty"`
	UsageLimits *UsageLimits `json:"usage_limits,omitempty"`
}

ServerlessClusterUpdateSpecification struct for ServerlessClusterUpdateSpecification.

func NewServerlessClusterUpdateSpecification 

func NewServerlessClusterUpdateSpecification() *ServerlessClusterUpdateSpecification

NewServerlessClusterUpdateSpecification instantiates a new ServerlessClusterUpdateSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*ServerlessClusterUpdateSpecification) GetPrimaryRegion added in v1.3.0 

func (o *ServerlessClusterUpdateSpecification) GetPrimaryRegion() string

GetPrimaryRegion returns the PrimaryRegion field value if set, zero value otherwise.

func (*ServerlessClusterUpdateSpecification) GetRegions added in v1.3.0 

func (o *ServerlessClusterUpdateSpecification) GetRegions() []string

GetRegions returns the Regions field value if set, zero value otherwise.

func (*ServerlessClusterUpdateSpecification) GetSpendLimit 

func (o *ServerlessClusterUpdateSpecification) GetSpendLimit() int32

GetSpendLimit returns the SpendLimit field value if set, zero value otherwise.

func (*ServerlessClusterUpdateSpecification) GetUsageLimits added in v1.0.0 

func (o *ServerlessClusterUpdateSpecification) GetUsageLimits() UsageLimits

GetUsageLimits returns the UsageLimits field value if set, zero value otherwise.

func (*ServerlessClusterUpdateSpecification) SetPrimaryRegion added in v1.3.0 

func (o *ServerlessClusterUpdateSpecification) SetPrimaryRegion(v string)

SetPrimaryRegion gets a reference to the given string and assigns it to the PrimaryRegion field.

func (*ServerlessClusterUpdateSpecification) SetRegions added in v1.3.0 

func (o *ServerlessClusterUpdateSpecification) SetRegions(v []string)

SetRegions gets a reference to the given []string and assigns it to the Regions field.

func (*ServerlessClusterUpdateSpecification) SetSpendLimit 

func (o *ServerlessClusterUpdateSpecification) SetSpendLimit(v int32)

SetSpendLimit gets a reference to the given int32 and assigns it to the SpendLimit field.

func (*ServerlessClusterUpdateSpecification) SetUsageLimits added in v1.0.0 

func (o *ServerlessClusterUpdateSpecification) SetUsageLimits(v UsageLimits)

SetUsageLimits gets a reference to the given UsageLimits and assigns it to the UsageLimits field.

type Service 

type Service interface {

	// Create a new API Key
	CreateApiKey(ctx _context.Context, createApiKeyRequest *CreateApiKeyRequest) (*CreateApiKeyResponse, *_nethttp.Response, error)
	// Delete an API Key
	DeleteApiKey(ctx _context.Context, id string) (*ApiKey, *_nethttp.Response, error)
	// Get an API Key by ID
	GetApiKey(ctx _context.Context, id string) (*ApiKey, *_nethttp.Response, error)
	// List API Keys
	ListApiKeys(ctx _context.Context, options *ListApiKeysOptions) (*ListApiKeysResponse, *_nethttp.Response, error)
	// Update an API Key
	UpdateApiKey(ctx _context.Context, id string, updateApiKeySpecification *UpdateApiKeySpecification) (*ApiKey, *_nethttp.Response, error)

	// List audit logs
	ListAuditLogs(ctx _context.Context, options *ListAuditLogsOptions) (*ListAuditLogsResponse, *_nethttp.Response, error)

	// Get a specific invoice for an organization
	GetInvoice(ctx _context.Context, invoiceId string) (*Invoice, *_nethttp.Response, error)
	// List invoices for a given organization
	ListInvoices(ctx _context.Context) (*ListInvoicesResponse, *_nethttp.Response, error)

	// Delete Client CA Cert for a cluster
	DeleteClientCACert(ctx _context.Context, clusterId string) (*ClientCACertInfo, *_nethttp.Response, error)
	// Get Client CA Cert information for a cluster
	GetClientCACert(ctx _context.Context, clusterId string) (*ClientCACertInfo, *_nethttp.Response, error)
	// Set Client CA Cert for a cluster
	SetClientCACert(ctx _context.Context, clusterId string, setClientCACertRequest *SetClientCACertRequest) (*ClientCACertInfo, *_nethttp.Response, error)
	// Update Client CA Cert for a cluster
	UpdateClientCACert(ctx _context.Context, clusterId string, updateClientCACertRequest *UpdateClientCACertRequest) (*ClientCACertInfo, *_nethttp.Response, error)

	// Create and initialize a new cluster
	CreateCluster(ctx _context.Context, createClusterRequest *CreateClusterRequest) (*Cluster, *_nethttp.Response, error)
	// Delete a cluster and all of its data
	DeleteCluster(ctx _context.Context, clusterId string) (*Cluster, *_nethttp.Response, error)
	// Get extended information about a cluster
	GetCluster(ctx _context.Context, clusterId string) (*Cluster, *_nethttp.Response, error)
	// Get a formatted generic connection string for a cluster
	GetConnectionString(ctx _context.Context, clusterId string, options *GetConnectionStringOptions) (*GetConnectionStringResponse, *_nethttp.Response, error)
	// List the regions available for new clusters and nodes
	ListAvailableRegions(ctx _context.Context, options *ListAvailableRegionsOptions) (*ListAvailableRegionsResponse, *_nethttp.Response, error)
	// List nodes for a cluster
	ListClusterNodes(ctx _context.Context, clusterId string, options *ListClusterNodesOptions) (*ListClusterNodesResponse, *_nethttp.Response, error)
	// List clusters owned by an organization
	ListClusters(ctx _context.Context, options *ListClustersOptions) (*ListClustersResponse, *_nethttp.Response, error)
	// List available major cluster versions
	ListMajorClusterVersions(ctx _context.Context, options *ListMajorClusterVersionsOptions) (*ListMajorClusterVersionsResponse, *_nethttp.Response, error)
	// Scale, edit or upgrade a cluster
	UpdateCluster(ctx _context.Context, clusterId string, updateClusterSpecification *UpdateClusterSpecification) (*Cluster, *_nethttp.Response, error)

	// Enable CMEK for a cluster
	EnableCMEKSpec(ctx _context.Context, clusterId string, cMEKClusterSpecification *CMEKClusterSpecification) (*CMEKClusterInfo, *_nethttp.Response, error)
	// Get CMEK-related information for a cluster
	GetCMEKClusterInfo(ctx _context.Context, clusterId string) (*CMEKClusterInfo, *_nethttp.Response, error)
	// Enable or update the CMEK spec for a cluster
	UpdateCMEKSpec(ctx _context.Context, clusterId string, cMEKClusterSpecification *CMEKClusterSpecification) (*CMEKClusterInfo, *_nethttp.Response, error)
	// Update the CMEK-related status for a cluster
	UpdateCMEKStatus(ctx _context.Context, clusterId string, updateCMEKStatusRequest *UpdateCMEKStatusRequest) (*CMEKClusterInfo, *_nethttp.Response, error)

	// Create a new database
	CreateDatabase(ctx _context.Context, clusterId string, createDatabaseRequest *CreateDatabaseRequest) (*Database, *_nethttp.Response, error)
	// Delete a database
	DeleteDatabase(ctx _context.Context, clusterId string, name string) (*Database, *_nethttp.Response, error)
	// Update a database
	EditDatabase(ctx _context.Context, clusterId string, name string, updateDatabaseRequest1 *UpdateDatabaseRequest1) (*Database, *_nethttp.Response, error)
	// Update a database
	EditDatabase2(ctx _context.Context, clusterId string, updateDatabaseRequest *UpdateDatabaseRequest) (*Database, *_nethttp.Response, error)
	// List databases for a cluster
	ListDatabases(ctx _context.Context, clusterId string, options *ListDatabasesOptions) (*ListDatabasesResponse, *_nethttp.Response, error)

	// Add an egress rule
	AddEgressRule(ctx _context.Context, clusterId string, addEgressRuleRequest *AddEgressRuleRequest) (*AddEgressRuleResponse, *_nethttp.Response, error)
	// Delete an existing egress rule
	DeleteEgressRule(ctx _context.Context, clusterId string, ruleId string, options *DeleteEgressRuleOptions) (*DeleteEgressRuleResponse, *_nethttp.Response, error)
	// Edit an existing egress rule
	EditEgressRule(ctx _context.Context, clusterId string, ruleId string, editEgressRuleRequest *EditEgressRuleRequest) (*EditEgressRuleResponse, *_nethttp.Response, error)
	// Get an existing egress rule
	GetEgressRule(ctx _context.Context, clusterId string, ruleId string) (*GetEgressRuleResponse, *_nethttp.Response, error)
	// List all egress rules associated with a cluster
	ListEgressRules(ctx _context.Context, clusterId string, options *ListEgressRulesOptions) (*ListEgressRulesResponse, *_nethttp.Response, error)
	// Outbound traffic management
	SetEgressTrafficPolicy(ctx _context.Context, clusterId string, setEgressTrafficPolicyRequest *SetEgressTrafficPolicyRequest) (*_nethttp.Response, error)

	// Create a folder
	CreateFolder(ctx _context.Context, createFolderRequest *CreateFolderRequest) (*FolderResource, *_nethttp.Response, error)
	// Delete a folder
	DeleteFolder(ctx _context.Context, folderId string) (*_nethttp.Response, error)
	// Get folder info for a folder
	GetFolder(ctx _context.Context, folderId string) (*FolderResource, *_nethttp.Response, error)
	// List contents of a folder
	ListFolderContents(ctx _context.Context, folderId string, options *ListFolderContentsOptions) (*FolderResourceList, *_nethttp.Response, error)
	// List folders owned by an organization
	ListFolders(ctx _context.Context, options *ListFoldersOptions) (*ListFoldersResponse, *_nethttp.Response, error)
	// Update a folder
	UpdateFolder(ctx _context.Context, folderId string, updateFolderSpecification *UpdateFolderSpecification) (*FolderResource, *_nethttp.Response, error)

	// Add a new CIDR address to the IP allowlist
	AddAllowlistEntry(ctx _context.Context, clusterId string, allowlistEntry *AllowlistEntry) (*AllowlistEntry, *_nethttp.Response, error)
	// Add a new CIDR address to the IP allowlist
	AddAllowlistEntry2(ctx _context.Context, clusterId string, entryCidrIp string, entryCidrMask int32, allowlistEntry1 *AllowlistEntry1) (*AllowlistEntry, *_nethttp.Response, error)
	// Delete an IP allowlist entry
	DeleteAllowlistEntry(ctx _context.Context, clusterId string, cidrIp string, cidrMask int32) (*AllowlistEntry, *_nethttp.Response, error)
	// Get the IP allowlist and propagation status for a cluster
	ListAllowlistEntries(ctx _context.Context, clusterId string, options *ListAllowlistEntriesOptions) (*ListAllowlistEntriesResponse, *_nethttp.Response, error)
	// Update an IP allowlist entry
	UpdateAllowlistEntry(ctx _context.Context, clusterId string, entryCidrIp string, entryCidrMask int32, allowlistEntry1 *AllowlistEntry1) (*AllowlistEntry, *_nethttp.Response, error)

	// Delete the Log Export configuration for a cluster
	DeleteLogExport(ctx _context.Context, clusterId string) (*LogExportClusterInfo, *_nethttp.Response, error)
	// Create or update the Log Export configuration for a cluster
	EnableLogExport(ctx _context.Context, clusterId string, enableLogExportRequest *EnableLogExportRequest) (*LogExportClusterInfo, *_nethttp.Response, error)
	// Get the Log Export configuration for a cluster
	GetLogExportInfo(ctx _context.Context, clusterId string) (*LogExportClusterInfo, *_nethttp.Response, error)

	// Delete the maintenance window for a cluster
	DeleteMaintenanceWindow(ctx _context.Context, clusterId string) (*MaintenanceWindow, *_nethttp.Response, error)
	// Get the maintenance window for a cluster
	GetMaintenanceWindow(ctx _context.Context, clusterId string) (*MaintenanceWindow, *_nethttp.Response, error)
	// Set the maintenance window for a cluster
	SetMaintenanceWindow(ctx _context.Context, clusterId string, maintenanceWindow *MaintenanceWindow) (*MaintenanceWindow, *_nethttp.Response, error)

	// Delete the CloudWatch Metric Export configuration for a cluster
	DeleteCloudWatchMetricExport(ctx _context.Context, clusterId string) (*DeleteMetricExportResponse, *_nethttp.Response, error)
	// Delete the Datadog Metric Export configuration for a cluster
	DeleteDatadogMetricExport(ctx _context.Context, clusterId string) (*DeleteMetricExportResponse, *_nethttp.Response, error)
	// Delete the Prometheus Metric Export configuration for a cluster
	DeletePrometheusMetricExport(ctx _context.Context, clusterId string) (*DeleteMetricExportResponse, *_nethttp.Response, error)
	// Create or update the CloudWatch Metric Export configuration for a cluster
	EnableCloudWatchMetricExport(ctx _context.Context, clusterId string, enableCloudWatchMetricExportRequest *EnableCloudWatchMetricExportRequest) (*CloudWatchMetricExportInfo, *_nethttp.Response, error)
	// Create or update the Datadog Metric Export configuration for a cluster
	EnableDatadogMetricExport(ctx _context.Context, clusterId string, enableDatadogMetricExportRequest *EnableDatadogMetricExportRequest) (*DatadogMetricExportInfo, *_nethttp.Response, error)
	// Create or update the Prometheus Metric Export configuration for a cluster
	EnablePrometheusMetricExport(ctx _context.Context, clusterId string, body *map[string]interface{}) (*PrometheusMetricExportInfo, *_nethttp.Response, error)
	// Get the CloudWatch Metric Export configuration for a cluster
	GetCloudWatchMetricExportInfo(ctx _context.Context, clusterId string) (*CloudWatchMetricExportInfo, *_nethttp.Response, error)
	// Get the Datadog Metric Export configuration for a cluster
	GetDatadogMetricExportInfo(ctx _context.Context, clusterId string) (*DatadogMetricExportInfo, *_nethttp.Response, error)
	// Get the Prometheus Metric Export configuration for a cluster
	GetPrometheusMetricExportInfo(ctx _context.Context, clusterId string) (*PrometheusMetricExportInfo, *_nethttp.Response, error)

	// Create an API OIDC configuration
	CreateApiOidcConfig(ctx _context.Context, createApiOidcConfigRequest *CreateApiOidcConfigRequest) (*ApiOidcConfig, *_nethttp.Response, error)
	// Delete an API OIDC configuration
	DeleteApiOidcConfig(ctx _context.Context, id string) (*ApiOidcConfig, *_nethttp.Response, error)
	// Get an API OIDC configuration
	GetApiOidcConfig(ctx _context.Context, id string) (*ApiOidcConfig, *_nethttp.Response, error)
	// List all API OIDC configurations
	ListApiOidcConfig(ctx _context.Context, options *ListApiOidcConfigOptions) (*ListApiOidcConfigResponse, *_nethttp.Response, error)
	// Update an API OIDC configuration
	UpdateApiOidcConfig(ctx _context.Context, id string, apiOidcConfig1 *ApiOidcConfig1) (*ApiOidcConfig, *_nethttp.Response, error)

	// Get information about the caller&#39;s organization
	GetOrganizationInfo(ctx _context.Context) (*Organization, *_nethttp.Response, error)

	// Add a connection to a cluster&#39;s private endpoint service.
	AddPrivateEndpointConnection(ctx _context.Context, clusterId string, addPrivateEndpointConnectionRequest *AddPrivateEndpointConnectionRequest) (*PrivateEndpointConnection, *_nethttp.Response, error)
	// Add a private endpoint trusted owner to a cluster
	AddPrivateEndpointTrustedOwner(ctx _context.Context, clusterId string, addPrivateEndpointTrustedOwnerRequest *AddPrivateEndpointTrustedOwnerRequest) (*AddPrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)
	// Create all PrivateEndpointServices for a cluster
	CreatePrivateEndpointServices(ctx _context.Context, clusterId string) (*PrivateEndpointServices, *_nethttp.Response, error)
	// Delete a connection from a cluster&#39;s private endpoint service.
	DeletePrivateEndpointConnection(ctx _context.Context, clusterId string, endpointId string) (*_nethttp.Response, error)
	// Get a private endpoint trusted owner entry for a cluster
	GetPrivateEndpointTrustedOwner(ctx _context.Context, clusterId string, ownerId string) (*GetPrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)
	// List all AwsEndpointConnections for a cluster
	ListAwsEndpointConnections(ctx _context.Context, clusterId string) (*AwsEndpointConnections, *_nethttp.Response, error)
	// List all connections to a cluster&#39;s private endpoint service.
	ListPrivateEndpointConnections(ctx _context.Context, clusterId string) (*PrivateEndpointConnections, *_nethttp.Response, error)
	// List all PrivateEndpointServices for a cluster
	ListPrivateEndpointServices(ctx _context.Context, clusterId string) (*PrivateEndpointServices, *_nethttp.Response, error)
	// List all private endpoint trusted owners for a cluster
	ListPrivateEndpointTrustedOwners(ctx _context.Context, clusterId string) (*ListPrivateEndpointTrustedOwnersResponse, *_nethttp.Response, error)
	// Remove a private endpoint trusted owner from a cluster
	RemovePrivateEndpointTrustedOwner(ctx _context.Context, clusterId string, ownerId string) (*RemovePrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)
	// Set the AWS Endpoint Connection state
	SetAwsEndpointConnectionState(ctx _context.Context, clusterId string, endpointId string, setAwsEndpointConnectionStateRequest *SetAwsEndpointConnectionStateRequest) (*AwsEndpointConnection, *_nethttp.Response, error)

	// Add a role to a user or service account
	AddUserToRole(ctx _context.Context, userId string, resourceType string, resourceId string, roleName string) (*GetAllRolesForUserResponse, *_nethttp.Response, error)
	// Get all Role Grants for a user
	GetAllRolesForUser(ctx _context.Context, userId string) (*GetAllRolesForUserResponse, *_nethttp.Response, error)
	// Search person users by email address
	GetPersonUsersByEmail(ctx _context.Context, email *string) (*GetPersonUsersByEmailResponse, *_nethttp.Response, error)
	// List all RoleGrants
	ListRoleGrants(ctx _context.Context, options *ListRoleGrantsOptions) (*ListRoleGrantsResponse, *_nethttp.Response, error)
	// Remove a role from a user or service account
	RemoveUserFromRole(ctx _context.Context, userId string, resourceType string, resourceId string, roleName string) (*GetAllRolesForUserResponse, *_nethttp.Response, error)
	// Replace the roles for a user or service account with exactly those provided
	SetRolesForUser(ctx _context.Context, userId string, cockroachCloudSetRolesForUserRequest *CockroachCloudSetRolesForUserRequest) (*GetAllRolesForUserResponse, *_nethttp.Response, error)

	// Create a group
	CreateGroup(ctx _context.Context, createGroupRequest *CreateGroupRequest) (*ScimGroup, *_nethttp.Response, error)
	// Create a user
	CreateUser(ctx _context.Context, createUserRequest *CreateUserRequest) (*ScimUser, *_nethttp.Response, error)
	// Delete a group based on ID
	DeleteGroup(ctx _context.Context, id string) (*_nethttp.Response, error)
	// Delete a user based on ID
	DeleteUser(ctx _context.Context, id string) (*_nethttp.Response, error)
	// Get a group by ID
	GetGroup(ctx _context.Context, id string, options *GetGroupOptions) (*ScimGroup, *_nethttp.Response, error)
	// Deprecated: Search a group by ID (Deprecated)
	GetGroup2(ctx _context.Context, id string, getGroupRequest *GetGroupRequest) (*ScimGroup, *_nethttp.Response, error)
	// List groups
	GetGroups(ctx _context.Context, options *GetGroupsOptions) (*GetGroupsResponse, *_nethttp.Response, error)
	// Deprecated: Search groups (Deprecated)
	GetGroups2(ctx _context.Context, getGroupsRequest *GetGroupsRequest) (*GetGroupsResponse, *_nethttp.Response, error)
	// Get a SCIM resource type by ID
	GetResourceType(ctx _context.Context, resourceId string, options *GetResourceTypeOptions) (*ScimResourceType, *_nethttp.Response, error)
	// List the SCIM resource types
	GetResourceTypes(ctx _context.Context, options *GetResourceTypesOptions) (*GetResourceTypesResponse, *_nethttp.Response, error)
	// Get a SCIM schema by ID
	GetSchema(ctx _context.Context, schemaId string, options *GetSchemaOptions) (*ScimSchema, *_nethttp.Response, error)
	// List the SCIM schemas
	GetSchemas(ctx _context.Context, options *GetSchemasOptions) (*GetSchemasResponse, *_nethttp.Response, error)
	// Return the SCIM Service Provider configuration
	GetServiceProviderConfig(ctx _context.Context) (*GetServiceProviderConfigResponse, *_nethttp.Response, error)
	// Get a user by ID
	GetUser(ctx _context.Context, id string, options *GetUserOptions) (*ScimUser, *_nethttp.Response, error)
	// Deprecated: Search for a user by ID (Deprecated)
	GetUser2(ctx _context.Context, id string, getUserRequest *GetUserRequest) (*ScimUser, *_nethttp.Response, error)
	// List Users
	GetUsers(ctx _context.Context, options *GetUsersOptions) (*GetUsersResponse, *_nethttp.Response, error)
	// Deprecated: Search User (Deprecated)
	GetUsers2(ctx _context.Context, getUsersRequest *GetUsersRequest) (*GetUsersResponse, *_nethttp.Response, error)
	// Search a group by ID
	SearchGroup(ctx _context.Context, id string, getGroupRequest *GetGroupRequest) (*ScimGroup, *_nethttp.Response, error)
	// Search groups
	SearchGroups(ctx _context.Context, getGroupsRequest *GetGroupsRequest) (*GetGroupsResponse, *_nethttp.Response, error)
	// Search for a user by ID
	SearchUser(ctx _context.Context, id string, getUserRequest *GetUserRequest) (*ScimUser, *_nethttp.Response, error)
	// Search Users
	SearchUsers(ctx _context.Context, getUsersRequest *GetUsersRequest) (*GetUsersResponse, *_nethttp.Response, error)
	// Update a group by supplying all values of the user object
	UpdateGroup(ctx _context.Context, id string, updateGroupRequest *UpdateGroupRequest) (*ScimGroup, *_nethttp.Response, error)
	// Update a user by supplying all values of the user object
	UpdateUser(ctx _context.Context, id string, updateUserRequest *UpdateUserRequest) (*ScimUser, *_nethttp.Response, error)

	// Create a new SQL user
	CreateSQLUser(ctx _context.Context, clusterId string, createSQLUserRequest *CreateSQLUserRequest) (*SQLUser, *_nethttp.Response, error)
	// Delete a SQL user
	DeleteSQLUser(ctx _context.Context, clusterId string, name string) (*SQLUser, *_nethttp.Response, error)
	// List SQL users for a cluster
	ListSQLUsers(ctx _context.Context, clusterId string, options *ListSQLUsersOptions) (*ListSQLUsersResponse, *_nethttp.Response, error)
	// Update a SQL user&#39;s password
	UpdateSQLUserPassword(ctx _context.Context, clusterId string, name string, updateSQLUserPasswordRequest *UpdateSQLUserPasswordRequest) (*SQLUser, *_nethttp.Response, error)

	// Create a service account
	CreateServiceAccount(ctx _context.Context, createServiceAccountRequest *CreateServiceAccountRequest) (*ServiceAccount, *_nethttp.Response, error)
	// Delete a service account
	DeleteServiceAccount(ctx _context.Context, id string) (*ServiceAccount, *_nethttp.Response, error)
	// Get a service account by ID
	GetServiceAccount(ctx _context.Context, id string) (*ServiceAccount, *_nethttp.Response, error)
	// List service accounts for an organization
	ListServiceAccounts(ctx _context.Context, options *ListServiceAccountsOptions) (*ListServiceAccountsResponse, *_nethttp.Response, error)
	// Update a service account
	UpdateServiceAccount(ctx _context.Context, id string, updateServiceAccountSpecification *UpdateServiceAccountSpecification) (*ServiceAccount, *_nethttp.Response, error)

	// Get the version upgrade deferral policy for a cluster.
	GetClusterVersionDeferral(ctx _context.Context, clusterId string) (*ClusterVersionDeferral, *_nethttp.Response, error)
	// Set the version upgrade deferral policy for a cluster
	SetClusterVersionDeferral(ctx _context.Context, clusterId string, clusterVersionDeferral *ClusterVersionDeferral) (*ClusterVersionDeferral, *_nethttp.Response, error)
}

func NewService 

func NewService(c *Client) Service

NewService creates a new API service.

type ServiceAccount added in v1.11.0 

type ServiceAccount struct {
	// created_at represents the creation time of the service account.
	CreatedAt time.Time `json:"created_at"`
	// creator_name is the name of user that created the service account.
	CreatorName string `json:"creator_name"`
	// description of the service account.
	Description string `json:"description"`
	// roles that the service account has inherited via a group.
	GroupRoles []BuiltInFromGroups `json:"group_roles"`
	// The ID of the service account.
	Id string `json:"id"`
	// name of the service account.
	Name string `json:"name"`
	// roles that are assigned to the service account.
	Roles []BuiltInRole `json:"roles"`
}

ServiceAccount A service account is an identity scoped to an organization that represents a non-human user..

func NewServiceAccount added in v1.11.0 

func NewServiceAccount(createdAt time.Time, creatorName string, description string, groupRoles []BuiltInFromGroups, id string, name string, roles []BuiltInRole) *ServiceAccount

NewServiceAccount instantiates a new ServiceAccount object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewServiceAccountWithDefaults added in v1.11.0 

func NewServiceAccountWithDefaults() *ServiceAccount

NewServiceAccountWithDefaults instantiates a new ServiceAccount object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ServiceAccount) GetCreatedAt added in v1.11.0 

func (o *ServiceAccount) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value.

func (*ServiceAccount) GetCreatorName added in v1.11.0 

func (o *ServiceAccount) GetCreatorName() string

GetCreatorName returns the CreatorName field value.

func (*ServiceAccount) GetDescription added in v1.11.0 

func (o *ServiceAccount) GetDescription() string

GetDescription returns the Description field value.

func (*ServiceAccount) GetGroupRoles added in v1.11.0 

func (o *ServiceAccount) GetGroupRoles() []BuiltInFromGroups

GetGroupRoles returns the GroupRoles field value.

func (*ServiceAccount) GetId added in v1.11.0 

func (o *ServiceAccount) GetId() string

GetId returns the Id field value.

func (*ServiceAccount) GetName added in v1.11.0 

func (o *ServiceAccount) GetName() string

GetName returns the Name field value.

func (*ServiceAccount) GetRoles added in v1.11.0 

func (o *ServiceAccount) GetRoles() []BuiltInRole

GetRoles returns the Roles field value.

func (*ServiceAccount) SetCreatedAt added in v1.11.0 

func (o *ServiceAccount) SetCreatedAt(v time.Time)

SetCreatedAt sets field value.

func (*ServiceAccount) SetCreatorName added in v1.11.0 

func (o *ServiceAccount) SetCreatorName(v string)

SetCreatorName sets field value.

func (*ServiceAccount) SetDescription added in v1.11.0 

func (o *ServiceAccount) SetDescription(v string)

SetDescription sets field value.

func (*ServiceAccount) SetGroupRoles added in v1.11.0 

func (o *ServiceAccount) SetGroupRoles(v []BuiltInFromGroups)

SetGroupRoles sets field value.

func (*ServiceAccount) SetId added in v1.11.0 

func (o *ServiceAccount) SetId(v string)

SetId sets field value.

func (*ServiceAccount) SetName added in v1.11.0 

func (o *ServiceAccount) SetName(v string)

SetName sets field value.

func (*ServiceAccount) SetRoles added in v1.11.0 

func (o *ServiceAccount) SetRoles(v []BuiltInRole)

SetRoles sets field value.

type ServiceImpl 

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

Service for the Cockroach DB Cloud API

func (*ServiceImpl) AddAllowlistEntry 

func (a *ServiceImpl) AddAllowlistEntry(
	ctx _context.Context, clusterId string, allowlistEntry *AllowlistEntry,
) (*AllowlistEntry, *_nethttp.Response, error)

AddAllowlistEntry executes the request.

func (*ServiceImpl) AddAllowlistEntry2 

func (a *ServiceImpl) AddAllowlistEntry2(
	ctx _context.Context, clusterId string, entryCidrIp string, entryCidrMask int32, allowlistEntry1 *AllowlistEntry1,
) (*AllowlistEntry, *_nethttp.Response, error)

AddAllowlistEntry2 executes the request.

func (*ServiceImpl) AddEgressRule added in v0.3.3 

func (a *ServiceImpl) AddEgressRule(
	ctx _context.Context, clusterId string, addEgressRuleRequest *AddEgressRuleRequest,
) (*AddEgressRuleResponse, *_nethttp.Response, error)

AddEgressRule executes the request.

func (*ServiceImpl) AddPrivateEndpointConnection added in v1.8.0 

func (a *ServiceImpl) AddPrivateEndpointConnection(
	ctx _context.Context, clusterId string, addPrivateEndpointConnectionRequest *AddPrivateEndpointConnectionRequest,
) (*PrivateEndpointConnection, *_nethttp.Response, error)

AddPrivateEndpointConnection executes the request.

func (*ServiceImpl) AddPrivateEndpointTrustedOwner added in v1.6.0 

func (a *ServiceImpl) AddPrivateEndpointTrustedOwner(
	ctx _context.Context, clusterId string, addPrivateEndpointTrustedOwnerRequest *AddPrivateEndpointTrustedOwnerRequest,
) (*AddPrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)

AddPrivateEndpointTrustedOwner executes the request.

func (*ServiceImpl) AddUserToRole added in v0.4.2 

func (a *ServiceImpl) AddUserToRole(
	ctx _context.Context, userId string, resourceType string, resourceId string, roleName string,
) (*GetAllRolesForUserResponse, *_nethttp.Response, error)

AddUserToRole executes the request.

func (*ServiceImpl) CreateApiKey added in v1.11.0 

func (a *ServiceImpl) CreateApiKey(
	ctx _context.Context, createApiKeyRequest *CreateApiKeyRequest,
) (*CreateApiKeyResponse, *_nethttp.Response, error)

CreateApiKey executes the request.

func (*ServiceImpl) CreateApiOidcConfig added in v1.5.0 

func (a *ServiceImpl) CreateApiOidcConfig(
	ctx _context.Context, createApiOidcConfigRequest *CreateApiOidcConfigRequest,
) (*ApiOidcConfig, *_nethttp.Response, error)

CreateApiOidcConfig executes the request.

func (*ServiceImpl) CreateCluster 

func (a *ServiceImpl) CreateCluster(
	ctx _context.Context, createClusterRequest *CreateClusterRequest,
) (*Cluster, *_nethttp.Response, error)

CreateCluster executes the request.

func (*ServiceImpl) CreateDatabase 

func (a *ServiceImpl) CreateDatabase(
	ctx _context.Context, clusterId string, createDatabaseRequest *CreateDatabaseRequest,
) (*Database, *_nethttp.Response, error)

CreateDatabase executes the request.

func (*ServiceImpl) CreateFolder added in v1.4.0 

func (a *ServiceImpl) CreateFolder(
	ctx _context.Context, createFolderRequest *CreateFolderRequest,
) (*FolderResource, *_nethttp.Response, error)

CreateFolder executes the request.

func (*ServiceImpl) CreateGroup added in v1.1.0 

func (a *ServiceImpl) CreateGroup(
	ctx _context.Context, createGroupRequest *CreateGroupRequest,
) (*ScimGroup, *_nethttp.Response, error)

CreateGroup executes the request.

func (*ServiceImpl) CreatePrivateEndpointServices 

func (a *ServiceImpl) CreatePrivateEndpointServices(
	ctx _context.Context, clusterId string,
) (*PrivateEndpointServices, *_nethttp.Response, error)

CreatePrivateEndpointServices executes the request.

func (*ServiceImpl) CreateSQLUser 

func (a *ServiceImpl) CreateSQLUser(
	ctx _context.Context, clusterId string, createSQLUserRequest *CreateSQLUserRequest,
) (*SQLUser, *_nethttp.Response, error)

CreateSQLUser executes the request.

func (*ServiceImpl) CreateServiceAccount added in v1.11.0 

func (a *ServiceImpl) CreateServiceAccount(
	ctx _context.Context, createServiceAccountRequest *CreateServiceAccountRequest,
) (*ServiceAccount, *_nethttp.Response, error)

CreateServiceAccount executes the request.

func (*ServiceImpl) CreateUser added in v1.1.0 

func (a *ServiceImpl) CreateUser(
	ctx _context.Context, createUserRequest *CreateUserRequest,
) (*ScimUser, *_nethttp.Response, error)

CreateUser executes the request.

func (*ServiceImpl) DeleteAllowlistEntry 

func (a *ServiceImpl) DeleteAllowlistEntry(
	ctx _context.Context, clusterId string, cidrIp string, cidrMask int32,
) (*AllowlistEntry, *_nethttp.Response, error)

DeleteAllowlistEntry executes the request.

func (*ServiceImpl) DeleteApiKey added in v1.11.0 

func (a *ServiceImpl) DeleteApiKey(
	ctx _context.Context, id string,
) (*ApiKey, *_nethttp.Response, error)

DeleteApiKey executes the request.

func (*ServiceImpl) DeleteApiOidcConfig added in v1.5.0 

func (a *ServiceImpl) DeleteApiOidcConfig(
	ctx _context.Context, id string,
) (*ApiOidcConfig, *_nethttp.Response, error)

DeleteApiOidcConfig executes the request.

func (*ServiceImpl) DeleteClientCACert added in v0.4.2 

func (a *ServiceImpl) DeleteClientCACert(
	ctx _context.Context, clusterId string,
) (*ClientCACertInfo, *_nethttp.Response, error)

DeleteClientCACert executes the request.

func (*ServiceImpl) DeleteCloudWatchMetricExport added in v0.4.3 

func (a *ServiceImpl) DeleteCloudWatchMetricExport(
	ctx _context.Context, clusterId string,
) (*DeleteMetricExportResponse, *_nethttp.Response, error)

DeleteCloudWatchMetricExport executes the request.

func (*ServiceImpl) DeleteCluster 

func (a *ServiceImpl) DeleteCluster(
	ctx _context.Context, clusterId string,
) (*Cluster, *_nethttp.Response, error)

DeleteCluster executes the request.

func (*ServiceImpl) DeleteDatabase 

func (a *ServiceImpl) DeleteDatabase(
	ctx _context.Context, clusterId string, name string,
) (*Database, *_nethttp.Response, error)

DeleteDatabase executes the request.

func (*ServiceImpl) DeleteDatadogMetricExport added in v0.4.3 

func (a *ServiceImpl) DeleteDatadogMetricExport(
	ctx _context.Context, clusterId string,
) (*DeleteMetricExportResponse, *_nethttp.Response, error)

DeleteDatadogMetricExport executes the request.

func (*ServiceImpl) DeleteEgressRule added in v0.3.3 

func (a *ServiceImpl) DeleteEgressRule(
	ctx _context.Context, clusterId string, ruleId string, options *DeleteEgressRuleOptions,
) (*DeleteEgressRuleResponse, *_nethttp.Response, error)

DeleteEgressRule executes the request.

func (*ServiceImpl) DeleteFolder added in v1.4.0 

func (a *ServiceImpl) DeleteFolder(
	ctx _context.Context, folderId string,
) (*_nethttp.Response, error)

DeleteFolder executes the request.

func (*ServiceImpl) DeleteGroup added in v1.1.0 

func (a *ServiceImpl) DeleteGroup(
	ctx _context.Context, id string,
) (*_nethttp.Response, error)

DeleteGroup executes the request.

func (*ServiceImpl) DeleteLogExport 

func (a *ServiceImpl) DeleteLogExport(
	ctx _context.Context, clusterId string,
) (*LogExportClusterInfo, *_nethttp.Response, error)

DeleteLogExport executes the request.

func (*ServiceImpl) DeleteMaintenanceWindow added in v1.2.0 

func (a *ServiceImpl) DeleteMaintenanceWindow(
	ctx _context.Context, clusterId string,
) (*MaintenanceWindow, *_nethttp.Response, error)

DeleteMaintenanceWindow executes the request.

func (*ServiceImpl) DeletePrivateEndpointConnection added in v1.8.0 

func (a *ServiceImpl) DeletePrivateEndpointConnection(
	ctx _context.Context, clusterId string, endpointId string,
) (*_nethttp.Response, error)

DeletePrivateEndpointConnection executes the request.

func (*ServiceImpl) DeletePrometheusMetricExport added in v1.8.0 

func (a *ServiceImpl) DeletePrometheusMetricExport(
	ctx _context.Context, clusterId string,
) (*DeleteMetricExportResponse, *_nethttp.Response, error)

DeletePrometheusMetricExport executes the request.

func (*ServiceImpl) DeleteSQLUser 

func (a *ServiceImpl) DeleteSQLUser(
	ctx _context.Context, clusterId string, name string,
) (*SQLUser, *_nethttp.Response, error)

DeleteSQLUser executes the request.

func (*ServiceImpl) DeleteServiceAccount added in v1.11.0 

func (a *ServiceImpl) DeleteServiceAccount(
	ctx _context.Context, id string,
) (*ServiceAccount, *_nethttp.Response, error)

DeleteServiceAccount executes the request.

func (*ServiceImpl) DeleteUser added in v1.1.0 

func (a *ServiceImpl) DeleteUser(
	ctx _context.Context, id string,
) (*_nethttp.Response, error)

DeleteUser executes the request.

func (*ServiceImpl) EditDatabase 

func (a *ServiceImpl) EditDatabase(
	ctx _context.Context, clusterId string, name string, updateDatabaseRequest1 *UpdateDatabaseRequest1,
) (*Database, *_nethttp.Response, error)

EditDatabase executes the request.

func (*ServiceImpl) EditDatabase2 added in v1.0.0 

func (a *ServiceImpl) EditDatabase2(
	ctx _context.Context, clusterId string, updateDatabaseRequest *UpdateDatabaseRequest,
) (*Database, *_nethttp.Response, error)

EditDatabase2 executes the request.

func (*ServiceImpl) EditEgressRule added in v0.3.3 

func (a *ServiceImpl) EditEgressRule(
	ctx _context.Context, clusterId string, ruleId string, editEgressRuleRequest *EditEgressRuleRequest,
) (*EditEgressRuleResponse, *_nethttp.Response, error)

EditEgressRule executes the request.

func (*ServiceImpl) EnableCMEKSpec 

func (a *ServiceImpl) EnableCMEKSpec(
	ctx _context.Context, clusterId string, cMEKClusterSpecification *CMEKClusterSpecification,
) (*CMEKClusterInfo, *_nethttp.Response, error)

EnableCMEKSpec executes the request.

func (*ServiceImpl) EnableCloudWatchMetricExport added in v0.4.3 

func (a *ServiceImpl) EnableCloudWatchMetricExport(
	ctx _context.Context, clusterId string, enableCloudWatchMetricExportRequest *EnableCloudWatchMetricExportRequest,
) (*CloudWatchMetricExportInfo, *_nethttp.Response, error)

EnableCloudWatchMetricExport executes the request.

func (*ServiceImpl) EnableDatadogMetricExport added in v0.4.3 

func (a *ServiceImpl) EnableDatadogMetricExport(
	ctx _context.Context, clusterId string, enableDatadogMetricExportRequest *EnableDatadogMetricExportRequest,
) (*DatadogMetricExportInfo, *_nethttp.Response, error)

EnableDatadogMetricExport executes the request.

func (*ServiceImpl) EnableLogExport 

func (a *ServiceImpl) EnableLogExport(
	ctx _context.Context, clusterId string, enableLogExportRequest *EnableLogExportRequest,
) (*LogExportClusterInfo, *_nethttp.Response, error)

EnableLogExport executes the request.

func (*ServiceImpl) EnablePrometheusMetricExport added in v1.8.0 

func (a *ServiceImpl) EnablePrometheusMetricExport(
	ctx _context.Context, clusterId string, body *map[string]interface{},
) (*PrometheusMetricExportInfo, *_nethttp.Response, error)

EnablePrometheusMetricExport executes the request.

func (*ServiceImpl) GetAllRolesForUser added in v0.4.2 

func (a *ServiceImpl) GetAllRolesForUser(
	ctx _context.Context, userId string,
) (*GetAllRolesForUserResponse, *_nethttp.Response, error)

GetAllRolesForUser executes the request.

func (*ServiceImpl) GetApiKey added in v1.11.0 

func (a *ServiceImpl) GetApiKey(
	ctx _context.Context, id string,
) (*ApiKey, *_nethttp.Response, error)

GetApiKey executes the request.

func (*ServiceImpl) GetApiOidcConfig added in v1.5.0 

func (a *ServiceImpl) GetApiOidcConfig(
	ctx _context.Context, id string,
) (*ApiOidcConfig, *_nethttp.Response, error)

GetApiOidcConfig executes the request.

func (*ServiceImpl) GetCMEKClusterInfo 

func (a *ServiceImpl) GetCMEKClusterInfo(
	ctx _context.Context, clusterId string,
) (*CMEKClusterInfo, *_nethttp.Response, error)

GetCMEKClusterInfo executes the request.

func (*ServiceImpl) GetClientCACert added in v0.4.2 

func (a *ServiceImpl) GetClientCACert(
	ctx _context.Context, clusterId string,
) (*ClientCACertInfo, *_nethttp.Response, error)

GetClientCACert executes the request.

func (*ServiceImpl) GetCloudWatchMetricExportInfo added in v0.4.3 

func (a *ServiceImpl) GetCloudWatchMetricExportInfo(
	ctx _context.Context, clusterId string,
) (*CloudWatchMetricExportInfo, *_nethttp.Response, error)

GetCloudWatchMetricExportInfo executes the request.

func (*ServiceImpl) GetCluster 

func (a *ServiceImpl) GetCluster(
	ctx _context.Context, clusterId string,
) (*Cluster, *_nethttp.Response, error)

GetCluster executes the request.

func (*ServiceImpl) GetClusterVersionDeferral added in v1.2.0 

func (a *ServiceImpl) GetClusterVersionDeferral(
	ctx _context.Context, clusterId string,
) (*ClusterVersionDeferral, *_nethttp.Response, error)

GetClusterVersionDeferral executes the request.

func (*ServiceImpl) GetConnectionString added in v0.3.4 

func (a *ServiceImpl) GetConnectionString(
	ctx _context.Context, clusterId string, options *GetConnectionStringOptions,
) (*GetConnectionStringResponse, *_nethttp.Response, error)

GetConnectionString executes the request.

func (*ServiceImpl) GetDatadogMetricExportInfo added in v0.4.3 

func (a *ServiceImpl) GetDatadogMetricExportInfo(
	ctx _context.Context, clusterId string,
) (*DatadogMetricExportInfo, *_nethttp.Response, error)

GetDatadogMetricExportInfo executes the request.

func (*ServiceImpl) GetEgressRule added in v0.3.3 

func (a *ServiceImpl) GetEgressRule(
	ctx _context.Context, clusterId string, ruleId string,
) (*GetEgressRuleResponse, *_nethttp.Response, error)

GetEgressRule executes the request.

func (*ServiceImpl) GetFolder added in v1.4.0 

func (a *ServiceImpl) GetFolder(
	ctx _context.Context, folderId string,
) (*FolderResource, *_nethttp.Response, error)

GetFolder executes the request.

func (*ServiceImpl) GetGroup added in v1.1.0 

func (a *ServiceImpl) GetGroup(
	ctx _context.Context, id string, options *GetGroupOptions,
) (*ScimGroup, *_nethttp.Response, error)

GetGroup executes the request.

func (*ServiceImpl) GetGroup2 added in v1.1.0 

func (a *ServiceImpl) GetGroup2(
	ctx _context.Context, id string, getGroupRequest *GetGroupRequest,
) (*ScimGroup, *_nethttp.Response, error)

GetGroup2 executes the request. Deprecated.

func (*ServiceImpl) GetGroups added in v1.1.0 

func (a *ServiceImpl) GetGroups(
	ctx _context.Context, options *GetGroupsOptions,
) (*GetGroupsResponse, *_nethttp.Response, error)

GetGroups executes the request.

func (*ServiceImpl) GetGroups2 added in v1.1.0 

func (a *ServiceImpl) GetGroups2(
	ctx _context.Context, getGroupsRequest *GetGroupsRequest,
) (*GetGroupsResponse, *_nethttp.Response, error)

GetGroups2 executes the request. Deprecated.

func (*ServiceImpl) GetInvoice 

func (a *ServiceImpl) GetInvoice(
	ctx _context.Context, invoiceId string,
) (*Invoice, *_nethttp.Response, error)

GetInvoice executes the request.

func (*ServiceImpl) GetLogExportInfo 

func (a *ServiceImpl) GetLogExportInfo(
	ctx _context.Context, clusterId string,
) (*LogExportClusterInfo, *_nethttp.Response, error)

GetLogExportInfo executes the request.

func (*ServiceImpl) GetMaintenanceWindow added in v1.2.0 

func (a *ServiceImpl) GetMaintenanceWindow(
	ctx _context.Context, clusterId string,
) (*MaintenanceWindow, *_nethttp.Response, error)

GetMaintenanceWindow executes the request.

func (*ServiceImpl) GetOrganizationInfo added in v0.4.0 

func (a *ServiceImpl) GetOrganizationInfo(
	ctx _context.Context,
) (*Organization, *_nethttp.Response, error)

GetOrganizationInfo executes the request.

func (*ServiceImpl) GetPersonUsersByEmail added in v1.0.0 

func (a *ServiceImpl) GetPersonUsersByEmail(
	ctx _context.Context, email *string,
) (*GetPersonUsersByEmailResponse, *_nethttp.Response, error)

GetPersonUsersByEmail executes the request.

func (*ServiceImpl) GetPrivateEndpointTrustedOwner added in v1.6.0 

func (a *ServiceImpl) GetPrivateEndpointTrustedOwner(
	ctx _context.Context, clusterId string, ownerId string,
) (*GetPrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)

GetPrivateEndpointTrustedOwner executes the request.

func (*ServiceImpl) GetPrometheusMetricExportInfo added in v1.8.0 

func (a *ServiceImpl) GetPrometheusMetricExportInfo(
	ctx _context.Context, clusterId string,
) (*PrometheusMetricExportInfo, *_nethttp.Response, error)

GetPrometheusMetricExportInfo executes the request.

func (*ServiceImpl) GetResourceType added in v1.1.0 

func (a *ServiceImpl) GetResourceType(
	ctx _context.Context, resourceId string, options *GetResourceTypeOptions,
) (*ScimResourceType, *_nethttp.Response, error)

GetResourceType executes the request.

func (*ServiceImpl) GetResourceTypes added in v1.1.0 

func (a *ServiceImpl) GetResourceTypes(
	ctx _context.Context, options *GetResourceTypesOptions,
) (*GetResourceTypesResponse, *_nethttp.Response, error)

GetResourceTypes executes the request.

func (*ServiceImpl) GetSchema added in v1.1.0 

func (a *ServiceImpl) GetSchema(
	ctx _context.Context, schemaId string, options *GetSchemaOptions,
) (*ScimSchema, *_nethttp.Response, error)

GetSchema executes the request.

func (*ServiceImpl) GetSchemas added in v1.1.0 

func (a *ServiceImpl) GetSchemas(
	ctx _context.Context, options *GetSchemasOptions,
) (*GetSchemasResponse, *_nethttp.Response, error)

GetSchemas executes the request.

func (*ServiceImpl) GetServiceAccount added in v1.11.0 

func (a *ServiceImpl) GetServiceAccount(
	ctx _context.Context, id string,
) (*ServiceAccount, *_nethttp.Response, error)

GetServiceAccount executes the request.

func (*ServiceImpl) GetServiceProviderConfig added in v1.1.0 

func (a *ServiceImpl) GetServiceProviderConfig(
	ctx _context.Context,
) (*GetServiceProviderConfigResponse, *_nethttp.Response, error)

GetServiceProviderConfig executes the request.

func (*ServiceImpl) GetUser added in v1.1.0 

func (a *ServiceImpl) GetUser(
	ctx _context.Context, id string, options *GetUserOptions,
) (*ScimUser, *_nethttp.Response, error)

GetUser executes the request.

func (*ServiceImpl) GetUser2 added in v1.1.0 

func (a *ServiceImpl) GetUser2(
	ctx _context.Context, id string, getUserRequest *GetUserRequest,
) (*ScimUser, *_nethttp.Response, error)

GetUser2 executes the request. Deprecated.

func (*ServiceImpl) GetUsers added in v1.1.0 

func (a *ServiceImpl) GetUsers(
	ctx _context.Context, options *GetUsersOptions,
) (*GetUsersResponse, *_nethttp.Response, error)

GetUsers executes the request.

func (*ServiceImpl) GetUsers2 added in v1.1.0 

func (a *ServiceImpl) GetUsers2(
	ctx _context.Context, getUsersRequest *GetUsersRequest,
) (*GetUsersResponse, *_nethttp.Response, error)

GetUsers2 executes the request. Deprecated.

func (*ServiceImpl) ListAllowlistEntries 

func (a *ServiceImpl) ListAllowlistEntries(
	ctx _context.Context, clusterId string, options *ListAllowlistEntriesOptions,
) (*ListAllowlistEntriesResponse, *_nethttp.Response, error)

ListAllowlistEntries executes the request.

func (*ServiceImpl) ListApiKeys added in v1.11.0 

func (a *ServiceImpl) ListApiKeys(
	ctx _context.Context, options *ListApiKeysOptions,
) (*ListApiKeysResponse, *_nethttp.Response, error)

ListApiKeys executes the request.

func (*ServiceImpl) ListApiOidcConfig added in v1.5.0 

func (a *ServiceImpl) ListApiOidcConfig(
	ctx _context.Context, options *ListApiOidcConfigOptions,
) (*ListApiOidcConfigResponse, *_nethttp.Response, error)

ListApiOidcConfig executes the request.

func (*ServiceImpl) ListAuditLogs added in v1.1.0 

func (a *ServiceImpl) ListAuditLogs(
	ctx _context.Context, options *ListAuditLogsOptions,
) (*ListAuditLogsResponse, *_nethttp.Response, error)

ListAuditLogs executes the request.

func (*ServiceImpl) ListAvailableRegions 

func (a *ServiceImpl) ListAvailableRegions(
	ctx _context.Context, options *ListAvailableRegionsOptions,
) (*ListAvailableRegionsResponse, *_nethttp.Response, error)

ListAvailableRegions executes the request.

func (*ServiceImpl) ListAwsEndpointConnections 

func (a *ServiceImpl) ListAwsEndpointConnections(
	ctx _context.Context, clusterId string,
) (*AwsEndpointConnections, *_nethttp.Response, error)

ListAwsEndpointConnections executes the request.

func (*ServiceImpl) ListClusterNodes 

func (a *ServiceImpl) ListClusterNodes(
	ctx _context.Context, clusterId string, options *ListClusterNodesOptions,
) (*ListClusterNodesResponse, *_nethttp.Response, error)

ListClusterNodes executes the request.

func (*ServiceImpl) ListClusters 

func (a *ServiceImpl) ListClusters(
	ctx _context.Context, options *ListClustersOptions,
) (*ListClustersResponse, *_nethttp.Response, error)

ListClusters executes the request.

func (*ServiceImpl) ListDatabases 

func (a *ServiceImpl) ListDatabases(
	ctx _context.Context, clusterId string, options *ListDatabasesOptions,
) (*ListDatabasesResponse, *_nethttp.Response, error)

ListDatabases executes the request.

func (*ServiceImpl) ListEgressRules added in v0.3.3 

func (a *ServiceImpl) ListEgressRules(
	ctx _context.Context, clusterId string, options *ListEgressRulesOptions,
) (*ListEgressRulesResponse, *_nethttp.Response, error)

ListEgressRules executes the request.

func (*ServiceImpl) ListFolderContents added in v1.4.0 

func (a *ServiceImpl) ListFolderContents(
	ctx _context.Context, folderId string, options *ListFolderContentsOptions,
) (*FolderResourceList, *_nethttp.Response, error)

ListFolderContents executes the request.

func (*ServiceImpl) ListFolders added in v1.9.0 

func (a *ServiceImpl) ListFolders(
	ctx _context.Context, options *ListFoldersOptions,
) (*ListFoldersResponse, *_nethttp.Response, error)

ListFolders executes the request.

func (*ServiceImpl) ListInvoices 

func (a *ServiceImpl) ListInvoices(
	ctx _context.Context,
) (*ListInvoicesResponse, *_nethttp.Response, error)

ListInvoices executes the request.

func (*ServiceImpl) ListMajorClusterVersions added in v0.4.1 

func (a *ServiceImpl) ListMajorClusterVersions(
	ctx _context.Context, options *ListMajorClusterVersionsOptions,
) (*ListMajorClusterVersionsResponse, *_nethttp.Response, error)

ListMajorClusterVersions executes the request.

func (*ServiceImpl) ListPrivateEndpointConnections added in v1.8.0 

func (a *ServiceImpl) ListPrivateEndpointConnections(
	ctx _context.Context, clusterId string,
) (*PrivateEndpointConnections, *_nethttp.Response, error)

ListPrivateEndpointConnections executes the request.

func (*ServiceImpl) ListPrivateEndpointServices 

func (a *ServiceImpl) ListPrivateEndpointServices(
	ctx _context.Context, clusterId string,
) (*PrivateEndpointServices, *_nethttp.Response, error)

ListPrivateEndpointServices executes the request.

func (*ServiceImpl) ListPrivateEndpointTrustedOwners added in v1.6.0 

func (a *ServiceImpl) ListPrivateEndpointTrustedOwners(
	ctx _context.Context, clusterId string,
) (*ListPrivateEndpointTrustedOwnersResponse, *_nethttp.Response, error)

ListPrivateEndpointTrustedOwners executes the request.

func (*ServiceImpl) ListRoleGrants added in v0.4.2 

func (a *ServiceImpl) ListRoleGrants(
	ctx _context.Context, options *ListRoleGrantsOptions,
) (*ListRoleGrantsResponse, *_nethttp.Response, error)

ListRoleGrants executes the request.

func (*ServiceImpl) ListSQLUsers 

func (a *ServiceImpl) ListSQLUsers(
	ctx _context.Context, clusterId string, options *ListSQLUsersOptions,
) (*ListSQLUsersResponse, *_nethttp.Response, error)

ListSQLUsers executes the request.

func (*ServiceImpl) ListServiceAccounts added in v1.11.0 

func (a *ServiceImpl) ListServiceAccounts(
	ctx _context.Context, options *ListServiceAccountsOptions,
) (*ListServiceAccountsResponse, *_nethttp.Response, error)

ListServiceAccounts executes the request.

func (*ServiceImpl) RemovePrivateEndpointTrustedOwner added in v1.6.0 

func (a *ServiceImpl) RemovePrivateEndpointTrustedOwner(
	ctx _context.Context, clusterId string, ownerId string,
) (*RemovePrivateEndpointTrustedOwnerResponse, *_nethttp.Response, error)

RemovePrivateEndpointTrustedOwner executes the request.

func (*ServiceImpl) RemoveUserFromRole added in v0.4.2 

func (a *ServiceImpl) RemoveUserFromRole(
	ctx _context.Context, userId string, resourceType string, resourceId string, roleName string,
) (*GetAllRolesForUserResponse, *_nethttp.Response, error)

RemoveUserFromRole executes the request.

func (*ServiceImpl) SearchGroup added in v1.9.0 

func (a *ServiceImpl) SearchGroup(
	ctx _context.Context, id string, getGroupRequest *GetGroupRequest,
) (*ScimGroup, *_nethttp.Response, error)

SearchGroup executes the request.

func (*ServiceImpl) SearchGroups added in v1.9.0 

func (a *ServiceImpl) SearchGroups(
	ctx _context.Context, getGroupsRequest *GetGroupsRequest,
) (*GetGroupsResponse, *_nethttp.Response, error)

SearchGroups executes the request.

func (*ServiceImpl) SearchUser added in v1.9.0 

func (a *ServiceImpl) SearchUser(
	ctx _context.Context, id string, getUserRequest *GetUserRequest,
) (*ScimUser, *_nethttp.Response, error)

SearchUser executes the request.

func (*ServiceImpl) SearchUsers added in v1.9.0 

func (a *ServiceImpl) SearchUsers(
	ctx _context.Context, getUsersRequest *GetUsersRequest,
) (*GetUsersResponse, *_nethttp.Response, error)

SearchUsers executes the request.

func (*ServiceImpl) SetAwsEndpointConnectionState 

func (a *ServiceImpl) SetAwsEndpointConnectionState(
	ctx _context.Context, clusterId string, endpointId string, setAwsEndpointConnectionStateRequest *SetAwsEndpointConnectionStateRequest,
) (*AwsEndpointConnection, *_nethttp.Response, error)

SetAwsEndpointConnectionState executes the request.

func (*ServiceImpl) SetClientCACert added in v0.4.2 

func (a *ServiceImpl) SetClientCACert(
	ctx _context.Context, clusterId string, setClientCACertRequest *SetClientCACertRequest,
) (*ClientCACertInfo, *_nethttp.Response, error)

SetClientCACert executes the request.

func (*ServiceImpl) SetClusterVersionDeferral added in v1.2.0 

func (a *ServiceImpl) SetClusterVersionDeferral(
	ctx _context.Context, clusterId string, clusterVersionDeferral *ClusterVersionDeferral,
) (*ClusterVersionDeferral, *_nethttp.Response, error)

SetClusterVersionDeferral executes the request.

func (*ServiceImpl) SetEgressTrafficPolicy added in v0.3.3 

func (a *ServiceImpl) SetEgressTrafficPolicy(
	ctx _context.Context, clusterId string, setEgressTrafficPolicyRequest *SetEgressTrafficPolicyRequest,
) (*_nethttp.Response, error)

SetEgressTrafficPolicy executes the request.

func (*ServiceImpl) SetMaintenanceWindow added in v1.2.0 

func (a *ServiceImpl) SetMaintenanceWindow(
	ctx _context.Context, clusterId string, maintenanceWindow *MaintenanceWindow,
) (*MaintenanceWindow, *_nethttp.Response, error)

SetMaintenanceWindow executes the request.

func (*ServiceImpl) SetRolesForUser added in v0.4.2 

func (a *ServiceImpl) SetRolesForUser(
	ctx _context.Context, userId string, cockroachCloudSetRolesForUserRequest *CockroachCloudSetRolesForUserRequest,
) (*GetAllRolesForUserResponse, *_nethttp.Response, error)

SetRolesForUser executes the request.

func (*ServiceImpl) UpdateAllowlistEntry 

func (a *ServiceImpl) UpdateAllowlistEntry(
	ctx _context.Context, clusterId string, entryCidrIp string, entryCidrMask int32, allowlistEntry1 *AllowlistEntry1,
) (*AllowlistEntry, *_nethttp.Response, error)

UpdateAllowlistEntry executes the request.

func (*ServiceImpl) UpdateApiKey added in v1.11.0 

func (a *ServiceImpl) UpdateApiKey(
	ctx _context.Context, id string, updateApiKeySpecification *UpdateApiKeySpecification,
) (*ApiKey, *_nethttp.Response, error)

UpdateApiKey executes the request.

func (*ServiceImpl) UpdateApiOidcConfig added in v1.5.0 

func (a *ServiceImpl) UpdateApiOidcConfig(
	ctx _context.Context, id string, apiOidcConfig1 *ApiOidcConfig1,
) (*ApiOidcConfig, *_nethttp.Response, error)

UpdateApiOidcConfig executes the request.

func (*ServiceImpl) UpdateCMEKSpec 

func (a *ServiceImpl) UpdateCMEKSpec(
	ctx _context.Context, clusterId string, cMEKClusterSpecification *CMEKClusterSpecification,
) (*CMEKClusterInfo, *_nethttp.Response, error)

UpdateCMEKSpec executes the request.

func (*ServiceImpl) UpdateCMEKStatus 

func (a *ServiceImpl) UpdateCMEKStatus(
	ctx _context.Context, clusterId string, updateCMEKStatusRequest *UpdateCMEKStatusRequest,
) (*CMEKClusterInfo, *_nethttp.Response, error)

UpdateCMEKStatus executes the request.

func (*ServiceImpl) UpdateClientCACert added in v0.4.2 

func (a *ServiceImpl) UpdateClientCACert(
	ctx _context.Context, clusterId string, updateClientCACertRequest *UpdateClientCACertRequest,
) (*ClientCACertInfo, *_nethttp.Response, error)

UpdateClientCACert executes the request.

func (*ServiceImpl) UpdateCluster 

func (a *ServiceImpl) UpdateCluster(
	ctx _context.Context, clusterId string, updateClusterSpecification *UpdateClusterSpecification,
) (*Cluster, *_nethttp.Response, error)

UpdateCluster executes the request.

func (*ServiceImpl) UpdateFolder added in v1.4.0 

func (a *ServiceImpl) UpdateFolder(
	ctx _context.Context, folderId string, updateFolderSpecification *UpdateFolderSpecification,
) (*FolderResource, *_nethttp.Response, error)

UpdateFolder executes the request.

func (*ServiceImpl) UpdateGroup added in v1.1.0 

func (a *ServiceImpl) UpdateGroup(
	ctx _context.Context, id string, updateGroupRequest *UpdateGroupRequest,
) (*ScimGroup, *_nethttp.Response, error)

UpdateGroup executes the request.

func (*ServiceImpl) UpdateSQLUserPassword 

func (a *ServiceImpl) UpdateSQLUserPassword(
	ctx _context.Context, clusterId string, name string, updateSQLUserPasswordRequest *UpdateSQLUserPasswordRequest,
) (*SQLUser, *_nethttp.Response, error)

UpdateSQLUserPassword executes the request.

func (*ServiceImpl) UpdateServiceAccount added in v1.11.0 

func (a *ServiceImpl) UpdateServiceAccount(
	ctx _context.Context, id string, updateServiceAccountSpecification *UpdateServiceAccountSpecification,
) (*ServiceAccount, *_nethttp.Response, error)

UpdateServiceAccount executes the request.

func (*ServiceImpl) UpdateUser added in v1.1.0 

func (a *ServiceImpl) UpdateUser(
	ctx _context.Context, id string, updateUserRequest *UpdateUserRequest,
) (*ScimUser, *_nethttp.Response, error)

UpdateUser executes the request.

type SetAWSEndpointConnectionStatusType added in v1.0.0 

type SetAWSEndpointConnectionStatusType string

SetAWSEndpointConnectionStatusType - AVAILABLE: accept/verify the connection on the service side. - REJECTED: reject the connection on the service side. 

const (
	SETAWSENDPOINTCONNECTIONSTATUSTYPE_AVAILABLE SetAWSEndpointConnectionStatusType = "AVAILABLE"
	SETAWSENDPOINTCONNECTIONSTATUSTYPE_REJECTED  SetAWSEndpointConnectionStatusType = "REJECTED"
)

List of SetAWSEndpointConnectionStatus.Type.

func NewSetAWSEndpointConnectionStatusTypeFromValue added in v1.0.0 

func NewSetAWSEndpointConnectionStatusTypeFromValue(v string) (*SetAWSEndpointConnectionStatusType, error)

NewSetAWSEndpointConnectionStatusTypeFromValue returns a pointer to a valid SetAWSEndpointConnectionStatusType for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (SetAWSEndpointConnectionStatusType) IsValid added in v1.0.0 

func (v SetAWSEndpointConnectionStatusType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (SetAWSEndpointConnectionStatusType) Ptr added in v1.0.0 

func (v SetAWSEndpointConnectionStatusType) Ptr() *SetAWSEndpointConnectionStatusType

Ptr returns reference to SetAWSEndpointConnectionStatus.Type value.

type SetAwsEndpointConnectionStateRequest added in v1.0.0 

type SetAwsEndpointConnectionStateRequest struct {
	Status SetAWSEndpointConnectionStatusType `json:"status"`
}

SetAwsEndpointConnectionStateRequest struct for SetAwsEndpointConnectionStateRequest.

func NewSetAwsEndpointConnectionStateRequest added in v1.0.0 

func NewSetAwsEndpointConnectionStateRequest(status SetAWSEndpointConnectionStatusType) *SetAwsEndpointConnectionStateRequest

NewSetAwsEndpointConnectionStateRequest instantiates a new SetAwsEndpointConnectionStateRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSetAwsEndpointConnectionStateRequestWithDefaults added in v1.0.0 

func NewSetAwsEndpointConnectionStateRequestWithDefaults() *SetAwsEndpointConnectionStateRequest

NewSetAwsEndpointConnectionStateRequestWithDefaults instantiates a new SetAwsEndpointConnectionStateRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SetAwsEndpointConnectionStateRequest) GetStatus added in v1.0.0 

func (o *SetAwsEndpointConnectionStateRequest) GetStatus() SetAWSEndpointConnectionStatusType

GetStatus returns the Status field value.

func (*SetAwsEndpointConnectionStateRequest) SetStatus added in v1.0.0 

func (o *SetAwsEndpointConnectionStateRequest) SetStatus(v SetAWSEndpointConnectionStatusType)

SetStatus sets field value.

type SetClientCACertRequest added in v0.4.2 

type SetClientCACertRequest struct {
	X509PemCert string `json:"x509_pem_cert"`
}

SetClientCACertRequest struct for SetClientCACertRequest.

func NewSetClientCACertRequest added in v0.4.2 

func NewSetClientCACertRequest(x509PemCert string) *SetClientCACertRequest

NewSetClientCACertRequest instantiates a new SetClientCACertRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSetClientCACertRequestWithDefaults added in v0.4.2 

func NewSetClientCACertRequestWithDefaults() *SetClientCACertRequest

NewSetClientCACertRequestWithDefaults instantiates a new SetClientCACertRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SetClientCACertRequest) GetX509PemCert added in v0.4.2 

func (o *SetClientCACertRequest) GetX509PemCert() string

GetX509PemCert returns the X509PemCert field value.

func (*SetClientCACertRequest) SetX509PemCert added in v0.4.2 

func (o *SetClientCACertRequest) SetX509PemCert(v string)

SetX509PemCert sets field value.

type SetEgressTrafficPolicyRequest added in v0.3.3 

type SetEgressTrafficPolicyRequest struct {
	// allow_all, if true results in unrestricted egress traffic. If false, egress traffic is set to default-deny and is managed via the Egress Rule Management API.
	AllowAll bool `json:"allow_all"`
	// idempotency_key uniquely identifies this request. If not set, it will be set by the server.
	IdempotencyKey *string `json:"idempotency_key,omitempty"`
}

SetEgressTrafficPolicyRequest SetEgressTrafficPolicyRequest is the input for the SetEgressTrafficPolicy RPC..

func NewSetEgressTrafficPolicyRequest added in v0.3.3 

func NewSetEgressTrafficPolicyRequest(allowAll bool) *SetEgressTrafficPolicyRequest

NewSetEgressTrafficPolicyRequest instantiates a new SetEgressTrafficPolicyRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSetEgressTrafficPolicyRequestWithDefaults added in v0.3.3 

func NewSetEgressTrafficPolicyRequestWithDefaults() *SetEgressTrafficPolicyRequest

NewSetEgressTrafficPolicyRequestWithDefaults instantiates a new SetEgressTrafficPolicyRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SetEgressTrafficPolicyRequest) GetAllowAll added in v0.3.3 

func (o *SetEgressTrafficPolicyRequest) GetAllowAll() bool

GetAllowAll returns the AllowAll field value.

func (*SetEgressTrafficPolicyRequest) GetIdempotencyKey added in v0.3.3 

func (o *SetEgressTrafficPolicyRequest) GetIdempotencyKey() string

GetIdempotencyKey returns the IdempotencyKey field value if set, zero value otherwise.

func (*SetEgressTrafficPolicyRequest) SetAllowAll added in v0.3.3 

func (o *SetEgressTrafficPolicyRequest) SetAllowAll(v bool)

SetAllowAll sets field value.

func (*SetEgressTrafficPolicyRequest) SetIdempotencyKey added in v0.3.3 

func (o *SetEgressTrafficPolicyRequest) SetIdempotencyKey(v string)

SetIdempotencyKey gets a reference to the given string and assigns it to the IdempotencyKey field.

type SortOrder 

type SortOrder string

SortOrder - ASC: Sort in ascending order. This is the default unless otherwise specified. - DESC: Sort in descending order. 

const (
	SORTORDER_ASC  SortOrder = "ASC"
	SORTORDER_DESC SortOrder = "DESC"
)

List of SortOrder.

func NewSortOrderFromValue 

func NewSortOrderFromValue(v string) (*SortOrder, error)

NewSortOrderFromValue returns a pointer to a valid SortOrder for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (SortOrder) IsValid 

func (v SortOrder) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (SortOrder) Ptr 

func (v SortOrder) Ptr() *SortOrder

Ptr returns reference to SortOrder value.

type Status 

type Status struct {
	Code    *int32  `json:"code,omitempty"`
	Details *[]Any  `json:"details,omitempty"`
	Message *string `json:"message,omitempty"`
}

Status struct for Status.

func NewStatus 

func NewStatus() *Status

NewStatus instantiates a new Status object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*Status) GetCode 

func (o *Status) GetCode() int32

GetCode returns the Code field value if set, zero value otherwise.

func (*Status) GetDetails 

func (o *Status) GetDetails() []Any

GetDetails returns the Details field value if set, zero value otherwise.

func (*Status) GetMessage 

func (o *Status) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*Status) SetCode 

func (o *Status) SetCode(v int32)

SetCode gets a reference to the given int32 and assigns it to the Code field.

func (*Status) SetDetails 

func (o *Status) SetDetails(v []Any)

SetDetails gets a reference to the given []Any and assigns it to the Details field.

func (*Status) SetMessage 

func (o *Status) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

type UpdateApiKeySpecification added in v1.11.0 

type UpdateApiKeySpecification struct {
	// name of the api key.
	Name *string `json:"name,omitempty"`
}

UpdateApiKeySpecification struct for UpdateApiKeySpecification.

func NewUpdateApiKeySpecification added in v1.11.0 

func NewUpdateApiKeySpecification() *UpdateApiKeySpecification

NewUpdateApiKeySpecification instantiates a new UpdateApiKeySpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UpdateApiKeySpecification) GetName added in v1.11.0 

func (o *UpdateApiKeySpecification) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*UpdateApiKeySpecification) SetName added in v1.11.0 

func (o *UpdateApiKeySpecification) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type UpdateCMEKStatusRequest 

type UpdateCMEKStatusRequest struct {
	Action CMEKCustomerAction `json:"action"`
}

UpdateCMEKStatusRequest struct for UpdateCMEKStatusRequest.

func NewUpdateCMEKStatusRequest 

func NewUpdateCMEKStatusRequest(action CMEKCustomerAction) *UpdateCMEKStatusRequest

NewUpdateCMEKStatusRequest instantiates a new UpdateCMEKStatusRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateCMEKStatusRequestWithDefaults 

func NewUpdateCMEKStatusRequestWithDefaults() *UpdateCMEKStatusRequest

NewUpdateCMEKStatusRequestWithDefaults instantiates a new UpdateCMEKStatusRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateCMEKStatusRequest) GetAction 

func (o *UpdateCMEKStatusRequest) GetAction() CMEKCustomerAction

GetAction returns the Action field value.

func (*UpdateCMEKStatusRequest) SetAction 

func (o *UpdateCMEKStatusRequest) SetAction(v CMEKCustomerAction)

SetAction sets field value.

type UpdateClientCACertRequest added in v0.4.2 

type UpdateClientCACertRequest struct {
	X509PemCert *string `json:"x509_pem_cert,omitempty"`
}

UpdateClientCACertRequest struct for UpdateClientCACertRequest.

func NewUpdateClientCACertRequest added in v0.4.2 

func NewUpdateClientCACertRequest() *UpdateClientCACertRequest

NewUpdateClientCACertRequest instantiates a new UpdateClientCACertRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UpdateClientCACertRequest) GetX509PemCert added in v0.4.2 

func (o *UpdateClientCACertRequest) GetX509PemCert() string

GetX509PemCert returns the X509PemCert field value if set, zero value otherwise.

func (*UpdateClientCACertRequest) SetX509PemCert added in v0.4.2 

func (o *UpdateClientCACertRequest) SetX509PemCert(v string)

SetX509PemCert gets a reference to the given string and assigns it to the X509PemCert field.

type UpdateClusterSpecification 

type UpdateClusterSpecification struct {
	Dedicated        *DedicatedClusterUpdateSpecification `json:"dedicated,omitempty"`
	DeleteProtection *DeleteProtectionStateType           `json:"delete_protection,omitempty"`
	// Limited Access: The parent ID is a folder ID. An empty string or \"root\" represents the root level.
	ParentId      *string                               `json:"parent_id,omitempty"`
	Serverless    *ServerlessClusterUpdateSpecification `json:"serverless,omitempty"`
	UpgradeStatus *ClusterUpgradeStatusType             `json:"upgrade_status,omitempty"`
}

UpdateClusterSpecification struct for UpdateClusterSpecification.

func NewUpdateClusterSpecification 

func NewUpdateClusterSpecification() *UpdateClusterSpecification

NewUpdateClusterSpecification instantiates a new UpdateClusterSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UpdateClusterSpecification) GetDedicated 

func (o *UpdateClusterSpecification) GetDedicated() DedicatedClusterUpdateSpecification

GetDedicated returns the Dedicated field value if set, zero value otherwise.

func (*UpdateClusterSpecification) GetDeleteProtection added in v1.10.0 

func (o *UpdateClusterSpecification) GetDeleteProtection() DeleteProtectionStateType

GetDeleteProtection returns the DeleteProtection field value if set, zero value otherwise.

func (*UpdateClusterSpecification) GetParentId added in v1.4.0 

func (o *UpdateClusterSpecification) GetParentId() string

GetParentId returns the ParentId field value if set, zero value otherwise.

func (*UpdateClusterSpecification) GetServerless 

func (o *UpdateClusterSpecification) GetServerless() ServerlessClusterUpdateSpecification

GetServerless returns the Serverless field value if set, zero value otherwise.

func (*UpdateClusterSpecification) GetUpgradeStatus added in v0.4.0 

func (o *UpdateClusterSpecification) GetUpgradeStatus() ClusterUpgradeStatusType

GetUpgradeStatus returns the UpgradeStatus field value if set, zero value otherwise.

func (*UpdateClusterSpecification) SetDedicated 

func (o *UpdateClusterSpecification) SetDedicated(v DedicatedClusterUpdateSpecification)

SetDedicated gets a reference to the given DedicatedClusterUpdateSpecification and assigns it to the Dedicated field.

func (*UpdateClusterSpecification) SetDeleteProtection added in v1.10.0 

func (o *UpdateClusterSpecification) SetDeleteProtection(v DeleteProtectionStateType)

SetDeleteProtection gets a reference to the given DeleteProtectionStateType and assigns it to the DeleteProtection field.

func (*UpdateClusterSpecification) SetParentId added in v1.4.0 

func (o *UpdateClusterSpecification) SetParentId(v string)

SetParentId gets a reference to the given string and assigns it to the ParentId field.

func (*UpdateClusterSpecification) SetServerless 

func (o *UpdateClusterSpecification) SetServerless(v ServerlessClusterUpdateSpecification)

SetServerless gets a reference to the given ServerlessClusterUpdateSpecification and assigns it to the Serverless field.

func (*UpdateClusterSpecification) SetUpgradeStatus added in v0.4.0 

func (o *UpdateClusterSpecification) SetUpgradeStatus(v ClusterUpgradeStatusType)

SetUpgradeStatus gets a reference to the given ClusterUpgradeStatusType and assigns it to the UpgradeStatus field.

type UpdateDatabaseRequest 

type UpdateDatabaseRequest struct {
	Name    string `json:"name"`
	NewName string `json:"new_name"`
}

UpdateDatabaseRequest struct for UpdateDatabaseRequest.

func NewUpdateDatabaseRequest 

func NewUpdateDatabaseRequest(name string, newName string) *UpdateDatabaseRequest

NewUpdateDatabaseRequest instantiates a new UpdateDatabaseRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateDatabaseRequestWithDefaults 

func NewUpdateDatabaseRequestWithDefaults() *UpdateDatabaseRequest

NewUpdateDatabaseRequestWithDefaults instantiates a new UpdateDatabaseRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateDatabaseRequest) GetName 

func (o *UpdateDatabaseRequest) GetName() string

GetName returns the Name field value.

func (*UpdateDatabaseRequest) GetNewName 

func (o *UpdateDatabaseRequest) GetNewName() string

GetNewName returns the NewName field value.

func (*UpdateDatabaseRequest) SetName 

func (o *UpdateDatabaseRequest) SetName(v string)

SetName sets field value.

func (*UpdateDatabaseRequest) SetNewName 

func (o *UpdateDatabaseRequest) SetNewName(v string)

SetNewName sets field value.

type UpdateDatabaseRequest1 added in v1.0.0 

type UpdateDatabaseRequest1 struct {
	NewName string `json:"new_name"`
}

UpdateDatabaseRequest1 struct for UpdateDatabaseRequest1.

func NewUpdateDatabaseRequest1 added in v1.0.0 

func NewUpdateDatabaseRequest1(newName string) *UpdateDatabaseRequest1

NewUpdateDatabaseRequest1 instantiates a new UpdateDatabaseRequest1 object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateDatabaseRequest1WithDefaults added in v1.0.0 

func NewUpdateDatabaseRequest1WithDefaults() *UpdateDatabaseRequest1

NewUpdateDatabaseRequest1WithDefaults instantiates a new UpdateDatabaseRequest1 object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateDatabaseRequest1) GetNewName added in v1.0.0 

func (o *UpdateDatabaseRequest1) GetNewName() string

GetNewName returns the NewName field value.

func (*UpdateDatabaseRequest1) SetNewName added in v1.0.0 

func (o *UpdateDatabaseRequest1) SetNewName(v string)

SetNewName sets field value.

type UpdateFolderSpecification added in v1.4.0 

type UpdateFolderSpecification struct {
	Name     *string `json:"name,omitempty"`
	ParentId *string `json:"parent_id,omitempty"`
}

UpdateFolderSpecification Set `parent_id` to empty string ” or 'root' to move a folder to the root level..

func NewUpdateFolderSpecification added in v1.4.0 

func NewUpdateFolderSpecification() *UpdateFolderSpecification

NewUpdateFolderSpecification instantiates a new UpdateFolderSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UpdateFolderSpecification) GetName added in v1.4.0 

func (o *UpdateFolderSpecification) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*UpdateFolderSpecification) GetParentId added in v1.4.0 

func (o *UpdateFolderSpecification) GetParentId() string

GetParentId returns the ParentId field value if set, zero value otherwise.

func (*UpdateFolderSpecification) SetName added in v1.4.0 

func (o *UpdateFolderSpecification) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*UpdateFolderSpecification) SetParentId added in v1.4.0 

func (o *UpdateFolderSpecification) SetParentId(v string)

SetParentId gets a reference to the given string and assigns it to the ParentId field.

type UpdateGroupRequest added in v1.1.0 

type UpdateGroupRequest struct {
	DisplayName string          `json:"displayName"`
	ExternalId  *string         `json:"externalId,omitempty"`
	Members     *[]ScimResource `json:"members,omitempty"`
	Schemas     *[]string       `json:"schemas,omitempty"`
}

UpdateGroupRequest struct for UpdateGroupRequest.

func NewUpdateGroupRequest added in v1.1.0 

func NewUpdateGroupRequest(displayName string) *UpdateGroupRequest

NewUpdateGroupRequest instantiates a new UpdateGroupRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateGroupRequestWithDefaults added in v1.1.0 

func NewUpdateGroupRequestWithDefaults() *UpdateGroupRequest

NewUpdateGroupRequestWithDefaults instantiates a new UpdateGroupRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateGroupRequest) GetDisplayName added in v1.1.0 

func (o *UpdateGroupRequest) GetDisplayName() string

GetDisplayName returns the DisplayName field value.

func (*UpdateGroupRequest) GetExternalId added in v1.1.0 

func (o *UpdateGroupRequest) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*UpdateGroupRequest) GetMembers added in v1.1.0 

func (o *UpdateGroupRequest) GetMembers() []ScimResource

GetMembers returns the Members field value if set, zero value otherwise.

func (*UpdateGroupRequest) GetSchemas added in v1.1.0 

func (o *UpdateGroupRequest) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*UpdateGroupRequest) SetDisplayName added in v1.1.0 

func (o *UpdateGroupRequest) SetDisplayName(v string)

SetDisplayName sets field value.

func (*UpdateGroupRequest) SetExternalId added in v1.1.0 

func (o *UpdateGroupRequest) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*UpdateGroupRequest) SetMembers added in v1.1.0 

func (o *UpdateGroupRequest) SetMembers(v []ScimResource)

SetMembers gets a reference to the given []ScimResource and assigns it to the Members field.

func (*UpdateGroupRequest) SetSchemas added in v1.1.0 

func (o *UpdateGroupRequest) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

type UpdateSQLUserPasswordRequest 

type UpdateSQLUserPasswordRequest struct {
	Password string `json:"password"`
}

UpdateSQLUserPasswordRequest struct for UpdateSQLUserPasswordRequest.

func NewUpdateSQLUserPasswordRequest 

func NewUpdateSQLUserPasswordRequest(password string) *UpdateSQLUserPasswordRequest

NewUpdateSQLUserPasswordRequest instantiates a new UpdateSQLUserPasswordRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateSQLUserPasswordRequestWithDefaults 

func NewUpdateSQLUserPasswordRequestWithDefaults() *UpdateSQLUserPasswordRequest

NewUpdateSQLUserPasswordRequestWithDefaults instantiates a new UpdateSQLUserPasswordRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateSQLUserPasswordRequest) GetPassword 

func (o *UpdateSQLUserPasswordRequest) GetPassword() string

GetPassword returns the Password field value.

func (*UpdateSQLUserPasswordRequest) SetPassword 

func (o *UpdateSQLUserPasswordRequest) SetPassword(v string)

SetPassword sets field value.

type UpdateServiceAccountSpecification added in v1.11.0 

type UpdateServiceAccountSpecification struct {
	// description of the service account.
	Description *string `json:"description,omitempty"`
	// name of the service account.
	Name *string `json:"name,omitempty"`
}

UpdateServiceAccountSpecification struct for UpdateServiceAccountSpecification.

func NewUpdateServiceAccountSpecification added in v1.11.0 

func NewUpdateServiceAccountSpecification() *UpdateServiceAccountSpecification

NewUpdateServiceAccountSpecification instantiates a new UpdateServiceAccountSpecification object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UpdateServiceAccountSpecification) GetDescription added in v1.11.0 

func (o *UpdateServiceAccountSpecification) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*UpdateServiceAccountSpecification) GetName added in v1.11.0 

func (o *UpdateServiceAccountSpecification) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*UpdateServiceAccountSpecification) SetDescription added in v1.11.0 

func (o *UpdateServiceAccountSpecification) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*UpdateServiceAccountSpecification) SetName added in v1.11.0 

func (o *UpdateServiceAccountSpecification) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type UpdateUserRequest added in v1.1.0 

type UpdateUserRequest struct {
	Active      bool         `json:"active"`
	DisplayName *string      `json:"displayName,omitempty"`
	Emails      *[]ScimEmail `json:"emails,omitempty"`
	ExternalId  *string      `json:"externalId,omitempty"`
	Name        *ScimName    `json:"name,omitempty"`
	Schemas     *[]string    `json:"schemas,omitempty"`
	UserName    *string      `json:"userName,omitempty"`
}

UpdateUserRequest struct for UpdateUserRequest.

func NewUpdateUserRequest added in v1.1.0 

func NewUpdateUserRequest(active bool) *UpdateUserRequest

NewUpdateUserRequest instantiates a new UpdateUserRequest object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUpdateUserRequestWithDefaults added in v1.1.0 

func NewUpdateUserRequestWithDefaults() *UpdateUserRequest

NewUpdateUserRequestWithDefaults instantiates a new UpdateUserRequest object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UpdateUserRequest) GetActive added in v1.1.0 

func (o *UpdateUserRequest) GetActive() bool

GetActive returns the Active field value.

func (*UpdateUserRequest) GetDisplayName added in v1.1.0 

func (o *UpdateUserRequest) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise.

func (*UpdateUserRequest) GetEmails added in v1.1.0 

func (o *UpdateUserRequest) GetEmails() []ScimEmail

GetEmails returns the Emails field value if set, zero value otherwise.

func (*UpdateUserRequest) GetExternalId added in v1.1.0 

func (o *UpdateUserRequest) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*UpdateUserRequest) GetName added in v1.1.0 

func (o *UpdateUserRequest) GetName() ScimName

GetName returns the Name field value if set, zero value otherwise.

func (*UpdateUserRequest) GetSchemas added in v1.1.0 

func (o *UpdateUserRequest) GetSchemas() []string

GetSchemas returns the Schemas field value if set, zero value otherwise.

func (*UpdateUserRequest) GetUserName added in v1.1.0 

func (o *UpdateUserRequest) GetUserName() string

GetUserName returns the UserName field value if set, zero value otherwise.

func (*UpdateUserRequest) SetActive added in v1.1.0 

func (o *UpdateUserRequest) SetActive(v bool)

SetActive sets field value.

func (*UpdateUserRequest) SetDisplayName added in v1.1.0 

func (o *UpdateUserRequest) SetDisplayName(v string)

SetDisplayName gets a reference to the given string and assigns it to the DisplayName field.

func (*UpdateUserRequest) SetEmails added in v1.1.0 

func (o *UpdateUserRequest) SetEmails(v []ScimEmail)

SetEmails gets a reference to the given []ScimEmail and assigns it to the Emails field.

func (*UpdateUserRequest) SetExternalId added in v1.1.0 

func (o *UpdateUserRequest) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*UpdateUserRequest) SetName added in v1.1.0 

func (o *UpdateUserRequest) SetName(v ScimName)

SetName gets a reference to the given ScimName and assigns it to the Name field.

func (*UpdateUserRequest) SetSchemas added in v1.1.0 

func (o *UpdateUserRequest) SetSchemas(v []string)

SetSchemas gets a reference to the given []string and assigns it to the Schemas field.

func (*UpdateUserRequest) SetUserName added in v1.1.0 

func (o *UpdateUserRequest) SetUserName(v string)

SetUserName gets a reference to the given string and assigns it to the UserName field.

type UsageLimits added in v1.0.0 

type UsageLimits struct {
	// request_unit_limit is the maximum number of request units that the cluster can consume during the month. If this limit is exceeded, then the cluster is disabled until the limit is increased, or until the beginning of the next month when more free request units are granted. It is an error for this to be zero.
	RequestUnitLimit int64 `json:"request_unit_limit,string"`
	// storage_mib_limit is the maximum number of Mebibytes of storage that the cluster can have at any time during the month. If this limit is exceeded, then the cluster is throttled; only one SQL connection is allowed at a time, with the expectation that it is used to delete data to reduce storage usage. It is an error for this to be zero.
	StorageMibLimit int64 `json:"storage_mib_limit,string"`
}

UsageLimits struct for UsageLimits.

func NewUsageLimits added in v1.0.0 

func NewUsageLimits(requestUnitLimit int64, storageMibLimit int64) *UsageLimits

NewUsageLimits instantiates a new UsageLimits object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsageLimitsWithDefaults added in v1.0.0 

func NewUsageLimitsWithDefaults() *UsageLimits

NewUsageLimitsWithDefaults instantiates a new UsageLimits object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsageLimits) GetRequestUnitLimit added in v1.0.0 

func (o *UsageLimits) GetRequestUnitLimit() int64

GetRequestUnitLimit returns the RequestUnitLimit field value.

func (*UsageLimits) GetStorageMibLimit added in v1.0.0 

func (o *UsageLimits) GetStorageMibLimit() int64

GetStorageMibLimit returns the StorageMibLimit field value.

func (*UsageLimits) SetRequestUnitLimit added in v1.0.0 

func (o *UsageLimits) SetRequestUnitLimit(v int64)

SetRequestUnitLimit sets field value.

func (*UsageLimits) SetStorageMibLimit added in v1.0.0 

func (o *UsageLimits) SetStorageMibLimit(v int64)

SetStorageMibLimit sets field value.

type UserGroupRoleGrant added in v1.1.0 

type UserGroupRoleGrant struct {
	GroupRoles *[]BuiltInFromGroups `json:"group_roles,omitempty"`
	UserId     *string              `json:"user_id,omitempty"`
}

UserGroupRoleGrant struct for UserGroupRoleGrant.

func NewUserGroupRoleGrant added in v1.1.0 

func NewUserGroupRoleGrant() *UserGroupRoleGrant

NewUserGroupRoleGrant instantiates a new UserGroupRoleGrant object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func (*UserGroupRoleGrant) GetGroupRoles added in v1.1.0 

func (o *UserGroupRoleGrant) GetGroupRoles() []BuiltInFromGroups

GetGroupRoles returns the GroupRoles field value if set, zero value otherwise.

func (*UserGroupRoleGrant) GetUserId added in v1.1.0 

func (o *UserGroupRoleGrant) GetUserId() string

GetUserId returns the UserId field value if set, zero value otherwise.

func (*UserGroupRoleGrant) SetGroupRoles added in v1.1.0 

func (o *UserGroupRoleGrant) SetGroupRoles(v []BuiltInFromGroups)

SetGroupRoles gets a reference to the given []BuiltInFromGroups and assigns it to the GroupRoles field.

func (*UserGroupRoleGrant) SetUserId added in v1.1.0 

func (o *UserGroupRoleGrant) SetUserId(v string)

SetUserId gets a reference to the given string and assigns it to the UserId field.

type UserRoleGrants added in v0.4.2 

type UserRoleGrants struct {
	Roles  []BuiltInRole `json:"roles"`
	UserId string        `json:"user_id"`
}

UserRoleGrants struct for UserRoleGrants.

func NewUserRoleGrants added in v0.4.2 

func NewUserRoleGrants(roles []BuiltInRole, userId string) *UserRoleGrants

NewUserRoleGrants instantiates a new UserRoleGrants object. This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUserRoleGrantsWithDefaults added in v0.4.4 

func NewUserRoleGrantsWithDefaults() *UserRoleGrants

NewUserRoleGrantsWithDefaults instantiates a new UserRoleGrants object. This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UserRoleGrants) GetRoles added in v0.4.2 

func (o *UserRoleGrants) GetRoles() []BuiltInRole

GetRoles returns the Roles field value.

func (*UserRoleGrants) GetUserId added in v0.4.2 

func (o *UserRoleGrants) GetUserId() string

GetUserId returns the UserId field value.

func (*UserRoleGrants) SetRoles added in v0.4.2 

func (o *UserRoleGrants) SetRoles(v []BuiltInRole)

SetRoles sets field value.

func (*UserRoleGrants) SetUserId added in v0.4.2 

func (o *UserRoleGrants) SetUserId(v string)

SetUserId sets field value.

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.