adminserviceapiv1

package
v3.1.6 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2022 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package adminserviceapiv1 : Operations and models for the AdminServiceApiV1 service

Index

Constants

View Source 
const (
	GetLocationOptions_LocationID_Eu = "eu"
	GetLocationOptions_LocationID_Uk = "uk"
	GetLocationOptions_LocationID_Us = "us"
)

Constants associated with the GetLocationOptions.LocationID property. The programatic ID of the location that you want to work in.

View Source 
const (
	Location_ID_Eu = "eu"
	Location_ID_Uk = "uk"
	Location_ID_Us = "us"
)

Constants associated with the Location.ID property. The programatic ID of the location that you want to work in.

View Source 
const (
	LocationID_ID_Eu = "eu"
	LocationID_ID_Uk = "uk"
	LocationID_ID_Us = "us"
)

Constants associated with the LocationID.ID property. The programatic ID of the location that you want to work in.

View Source 
const (
	Region_ID_Eu = "eu"
	Region_ID_Uk = "uk"
	Region_ID_Us = "us"
)

Constants associated with the Region.ID property. The programatic ID of the available regions.

View Source 
const DefaultServiceName = "admin_service_api"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://us.compliance.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAccountSettings 

func UnmarshalAccountSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccountSettings unmarshals an instance of AccountSettings from the specified map of raw messages.

func UnmarshalLocation 

func UnmarshalLocation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocation unmarshals an instance of Location from the specified map of raw messages.

func UnmarshalLocationID 

func UnmarshalLocationID(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocationID unmarshals an instance of LocationID from the specified map of raw messages.

func UnmarshalLocations 

func UnmarshalLocations(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocations unmarshals an instance of Locations from the specified map of raw messages.

func UnmarshalNotificationsRegistration added in v3.1.0 

func UnmarshalNotificationsRegistration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsRegistration unmarshals an instance of NotificationsRegistration from the specified map of raw messages.

func UnmarshalRegion 

func UnmarshalRegion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRegion unmarshals an instance of Region from the specified map of raw messages.

func UnmarshalTestEvent added in v3.1.0 

func UnmarshalTestEvent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTestEvent unmarshals an instance of TestEvent from the specified map of raw messages.

Types

type AccountSettings 

type AccountSettings struct {
	// Location settings.
	Location *LocationID `json:"location,omitempty"`

	// The Event Notification settings to register.
	EventNotifications *NotificationsRegistration `json:"event_notifications,omitempty"`
}

AccountSettings : Account settings.

type AdminServiceApiV1 

type AdminServiceApiV1 struct {
	Service *core.BaseService
}

AdminServiceApiV1 : This is an API for the Admin Service

API Version: 1.0.0

func NewAdminServiceApiV1 

func NewAdminServiceApiV1(options *AdminServiceApiV1Options) (service *AdminServiceApiV1, err error)

NewAdminServiceApiV1 : constructs an instance of AdminServiceApiV1 with passed in options.

func NewAdminServiceApiV1UsingExternalConfig 

func NewAdminServiceApiV1UsingExternalConfig(options *AdminServiceApiV1Options) (adminServiceApi *AdminServiceApiV1, err error)

NewAdminServiceApiV1UsingExternalConfig : constructs an instance of AdminServiceApiV1 with passed in options and external configuration.

func (*AdminServiceApiV1) Clone 

func (adminServiceApi *AdminServiceApiV1) Clone() *AdminServiceApiV1

Clone makes a copy of "adminServiceApi" suitable for processing requests.

func (*AdminServiceApiV1) DisableRetries 

func (adminServiceApi *AdminServiceApiV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*AdminServiceApiV1) EnableRetries 

func (adminServiceApi *AdminServiceApiV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*AdminServiceApiV1) GetEnableGzipCompression 

func (adminServiceApi *AdminServiceApiV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*AdminServiceApiV1) GetLocation 

func (adminServiceApi *AdminServiceApiV1) GetLocation(getLocationOptions *GetLocationOptions) (result *Location, response *core.DetailedResponse, err error)

GetLocation : View the details of a location View the endpoints and regions that are available for a specific region.

func (*AdminServiceApiV1) GetLocationWithContext 

func (adminServiceApi *AdminServiceApiV1) GetLocationWithContext(ctx context.Context, getLocationOptions *GetLocationOptions) (result *Location, response *core.DetailedResponse, err error)

GetLocationWithContext is an alternate form of the GetLocation method which supports a Context parameter

func (*AdminServiceApiV1) GetServiceURL 

func (adminServiceApi *AdminServiceApiV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*AdminServiceApiV1) GetSettings 

func (adminServiceApi *AdminServiceApiV1) GetSettings(getSettingsOptions *GetSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetSettings : View account settings View the current settings for a specific account.

func (*AdminServiceApiV1) GetSettingsWithContext 

func (adminServiceApi *AdminServiceApiV1) GetSettingsWithContext(ctx context.Context, getSettingsOptions *GetSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetSettingsWithContext is an alternate form of the GetSettings method which supports a Context parameter

func (*AdminServiceApiV1) ListLocations 

func (adminServiceApi *AdminServiceApiV1) ListLocations(listLocationsOptions *ListLocationsOptions) (result *Locations, response *core.DetailedResponse, err error)

ListLocations : View available locations View the available locations in which the data that is generated by the Security and Compliance Center can be managed.

func (*AdminServiceApiV1) ListLocationsWithContext 

func (adminServiceApi *AdminServiceApiV1) ListLocationsWithContext(ctx context.Context, listLocationsOptions *ListLocationsOptions) (result *Locations, response *core.DetailedResponse, err error)

ListLocationsWithContext is an alternate form of the ListLocations method which supports a Context parameter

func (*AdminServiceApiV1) NewGetLocationOptions 

func (*AdminServiceApiV1) NewGetLocationOptions(locationID string) *GetLocationOptions

NewGetLocationOptions : Instantiate GetLocationOptions

func (*AdminServiceApiV1) NewGetSettingsOptions 

func (*AdminServiceApiV1) NewGetSettingsOptions(accountID string) *GetSettingsOptions

NewGetSettingsOptions : Instantiate GetSettingsOptions

func (*AdminServiceApiV1) NewListLocationsOptions 

func (*AdminServiceApiV1) NewListLocationsOptions() *ListLocationsOptions

NewListLocationsOptions : Instantiate ListLocationsOptions

func (*AdminServiceApiV1) NewLocationID 

func (*AdminServiceApiV1) NewLocationID(id string) (_model *LocationID, err error)

NewLocationID : Instantiate LocationID (Generic Model Constructor)

func (*AdminServiceApiV1) NewNotificationsRegistration added in v3.1.0 

func (*AdminServiceApiV1) NewNotificationsRegistration(instanceCrn string) (_model *NotificationsRegistration, err error)

NewNotificationsRegistration : Instantiate NotificationsRegistration (Generic Model Constructor)

func (*AdminServiceApiV1) NewPatchAccountSettingsOptions 

func (*AdminServiceApiV1) NewPatchAccountSettingsOptions(accountID string) *PatchAccountSettingsOptions

NewPatchAccountSettingsOptions : Instantiate PatchAccountSettingsOptions

func (*AdminServiceApiV1) NewSendTestEventOptions added in v3.1.0 

func (*AdminServiceApiV1) NewSendTestEventOptions(accountID string) *SendTestEventOptions

NewSendTestEventOptions : Instantiate SendTestEventOptions

func (*AdminServiceApiV1) PatchAccountSettings 

func (adminServiceApi *AdminServiceApiV1) PatchAccountSettings(patchAccountSettingsOptions *PatchAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

PatchAccountSettings : Update account settings Update the settings for a specific account.

func (*AdminServiceApiV1) PatchAccountSettingsWithContext 

func (adminServiceApi *AdminServiceApiV1) PatchAccountSettingsWithContext(ctx context.Context, patchAccountSettingsOptions *PatchAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

PatchAccountSettingsWithContext is an alternate form of the PatchAccountSettings method which supports a Context parameter

func (*AdminServiceApiV1) SendTestEvent added in v3.1.0 

func (adminServiceApi *AdminServiceApiV1) SendTestEvent(sendTestEventOptions *SendTestEventOptions) (result *TestEvent, response *core.DetailedResponse, err error)

SendTestEvent : Send test event Send a test event using your configured Event Notifications instance.

func (*AdminServiceApiV1) SendTestEventWithContext added in v3.1.0 

func (adminServiceApi *AdminServiceApiV1) SendTestEventWithContext(ctx context.Context, sendTestEventOptions *SendTestEventOptions) (result *TestEvent, response *core.DetailedResponse, err error)

SendTestEventWithContext is an alternate form of the SendTestEvent method which supports a Context parameter

func (*AdminServiceApiV1) SetDefaultHeaders 

func (adminServiceApi *AdminServiceApiV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*AdminServiceApiV1) SetEnableGzipCompression 

func (adminServiceApi *AdminServiceApiV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*AdminServiceApiV1) SetServiceURL 

func (adminServiceApi *AdminServiceApiV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type AdminServiceApiV1Options 

type AdminServiceApiV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

AdminServiceApiV1Options : Service options

type GetLocationOptions 

type GetLocationOptions struct {
	// The programatic ID of the location that you want to work in.
	LocationID *string `json:"location_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLocationOptions : The GetLocation options.

func (*GetLocationOptions) SetHeaders 

func (options *GetLocationOptions) SetHeaders(param map[string]string) *GetLocationOptions

SetHeaders : Allow user to set Headers

func (*GetLocationOptions) SetLocationID 

func (_options *GetLocationOptions) SetLocationID(locationID string) *GetLocationOptions

SetLocationID : Allow user to set LocationID

type GetSettingsOptions 

type GetSettingsOptions struct {
	// The ID of the managing account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSettingsOptions : The GetSettings options.

func (*GetSettingsOptions) SetAccountID 

func (_options *GetSettingsOptions) SetAccountID(accountID string) *GetSettingsOptions

SetAccountID : Allow user to set AccountID

func (*GetSettingsOptions) SetHeaders 

func (options *GetSettingsOptions) SetHeaders(param map[string]string) *GetSettingsOptions

SetHeaders : Allow user to set Headers

type ListLocationsOptions 

type ListLocationsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListLocationsOptions : The ListLocations options.

func (*ListLocationsOptions) SetHeaders 

func (options *ListLocationsOptions) SetHeaders(param map[string]string) *ListLocationsOptions

SetHeaders : Allow user to set Headers

type Location 

type Location struct {
	// The programatic ID of the location that you want to work in.
	ID *string `json:"id,omitempty"`

	// The base URL for the service.
	MainEndpointURL *string `json:"main_endpoint_url,omitempty"`

	// The endpoint that is used to call the Configuration Governance APIs.
	GovernanceEndpointURL *string `json:"governance_endpoint_url,omitempty"`

	// The endpoint that is used to get the results for the Configuration Governance component.
	ResultsEndpointURL *string `json:"results_endpoint_url,omitempty"`

	// The endpoint that is used to call the Posture Management APIs.
	ComplianceEndpointURL *string `json:"compliance_endpoint_url,omitempty"`

	// The endpoint that is used to generate analytics for the Posture Management component.
	AnalyticsEndpointURL *string `json:"analytics_endpoint_url,omitempty"`

	// The endpoint that is used to call the Security Insights APIs.
	SiEndpointURL *string `json:"si_endpoint_url,omitempty"`

	Regions []Region `json:"regions,omitempty"`
}

Location : The location that your account is current set to use.

type LocationID 

type LocationID struct {
	// The programatic ID of the location that you want to work in.
	ID *string `json:"id" validate:"required"`
}

LocationID : Location settings.

type Locations 

type Locations struct {
	Locations []Location `json:"locations" validate:"required"`
}

Locations : An array of available locations.

type NotificationsRegistration added in v3.1.0 

type NotificationsRegistration struct {
	// The Cloud Resource Name (CRN) of the Event Notifications instance that you want to connect.
	InstanceCrn *string `json:"instance_crn" validate:"required"`

	// The name to register as a source in your Event Notifications instance.
	SourceName *string `json:"source_name,omitempty"`

	// An optional description for the source in your Event Notifications instance.
	SourceDescription *string `json:"source_description,omitempty"`
}

NotificationsRegistration : The Event Notification settings to register.

type PatchAccountSettingsOptions 

type PatchAccountSettingsOptions struct {
	// The ID of the managing account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Location settings.
	Location *LocationID `json:"location,omitempty"`

	// The Event Notification settings to register.
	EventNotifications *NotificationsRegistration `json:"event_notifications,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PatchAccountSettingsOptions : The PatchAccountSettings options.

func (*PatchAccountSettingsOptions) SetAccountID 

func (_options *PatchAccountSettingsOptions) SetAccountID(accountID string) *PatchAccountSettingsOptions

SetAccountID : Allow user to set AccountID

func (*PatchAccountSettingsOptions) SetEventNotifications added in v3.1.0 

func (_options *PatchAccountSettingsOptions) SetEventNotifications(eventNotifications *NotificationsRegistration) *PatchAccountSettingsOptions

SetEventNotifications : Allow user to set EventNotifications

func (*PatchAccountSettingsOptions) SetHeaders 

func (options *PatchAccountSettingsOptions) SetHeaders(param map[string]string) *PatchAccountSettingsOptions

SetHeaders : Allow user to set Headers

func (*PatchAccountSettingsOptions) SetLocation 

func (_options *PatchAccountSettingsOptions) SetLocation(location *LocationID) *PatchAccountSettingsOptions

SetLocation : Allow user to set Location

type Region 

type Region struct {
	// The programatic ID of the available regions.
	ID *string `json:"id" validate:"required"`
}

Region : The region or regions that are available for each location. Be sure to use the correct region ID when making your API call.

type SendTestEventOptions added in v3.1.0 

type SendTestEventOptions struct {
	// The ID of the managing account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SendTestEventOptions : The SendTestEvent options.

func (*SendTestEventOptions) SetAccountID added in v3.1.0 

func (_options *SendTestEventOptions) SetAccountID(accountID string) *SendTestEventOptions

SetAccountID : Allow user to set AccountID

func (*SendTestEventOptions) SetHeaders added in v3.1.0 

func (options *SendTestEventOptions) SetHeaders(param map[string]string) *SendTestEventOptions

SetHeaders : Allow user to set Headers

type TestEvent added in v3.1.0 

type TestEvent struct {
	// Indicates whether the event was received by Event Notifications.
	Success *bool `json:"success" validate:"required"`
}

TestEvent : The details of a test event response.

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.