eventhub

package
v17.4.0 Latest Latest
Warning

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

 Go to latest Published: Jun 19, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package eventhub implements the Azure ARM Eventhub service API version 2018-01-01-preview.

Azure Event Hubs Cluster client for managing Event Hubs Cluster resources.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Eventhub
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Eventhub.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Cluster 

type Cluster struct {
	autorest.Response `json:"-"`
	// Sku - Properties of the cluster SKU.
	Sku *ClusterSku `json:"sku,omitempty"`
	// ClusterProperties - Event Hubs Cluster properties supplied in responses in List or Get operations.
	*ClusterProperties `json:"properties,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
}

Cluster single Event Hubs Cluster resource in List or Get operations.

func (Cluster) MarshalJSON 

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON 

func (c *Cluster) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterListResult 

type ClusterListResult struct {
	autorest.Response `json:"-"`
	// Value - The Event Hubs Clusters present in the List Event Hubs operation results.
	Value *[]Cluster `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters.
	NextLink *string `json:"nextLink,omitempty"`
}

ClusterListResult the response of the List Event Hubs Clusters operation.

func (ClusterListResult) IsEmpty 

func (clr ClusterListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClusterListResultIterator 

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

ClusterListResultIterator provides access to a complete listing of Cluster values.

func (*ClusterListResultIterator) Next 

func (iter *ClusterListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ClusterListResultIterator) NotDone 

func (iter ClusterListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ClusterListResultIterator) Response 

func (iter ClusterListResultIterator) Response() ClusterListResult

Response returns the raw server response from the last page request.

func (ClusterListResultIterator) Value 

func (iter ClusterListResultIterator) Value() Cluster

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ClusterListResultPage 

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

ClusterListResultPage contains a page of Cluster values.

func (*ClusterListResultPage) Next 

func (page *ClusterListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ClusterListResultPage) NotDone 

func (page ClusterListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ClusterListResultPage) Response 

func (page ClusterListResultPage) Response() ClusterListResult

Response returns the raw server response from the last page request.

func (ClusterListResultPage) Values 

func (page ClusterListResultPage) Values() []Cluster

Values returns the slice of values for the current page or nil if there are no values.

type ClusterProperties 

type ClusterProperties struct {
	// Created - The UTC time when the Event Hubs Cluster was created.
	Created *string `json:"created,omitempty"`
	// Updated - The UTC time when the Event Hubs Cluster was last updated.
	Updated *string `json:"updated,omitempty"`
	// MetricID - The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
	MetricID *string `json:"metricId,omitempty"`
}

ClusterProperties event Hubs Cluster properties supplied in responses in List or Get operations.

type ClusterQuotaConfigurationProperties 

type ClusterQuotaConfigurationProperties struct {
	autorest.Response `json:"-"`
	// Settings - All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.
	Settings map[string]*string `json:"settings"`
}

ClusterQuotaConfigurationProperties contains all settings for the cluster.

func (ClusterQuotaConfigurationProperties) MarshalJSON 

func (cqcp ClusterQuotaConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterQuotaConfigurationProperties.

type ClusterSku 

type ClusterSku struct {
	// Name - Name of this SKU.
	Name *string `json:"name,omitempty"`
	// Capacity - The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
	Capacity *int32 `json:"capacity,omitempty"`
}

ClusterSku SKU parameters particular to a cluster instance.

type ClustersClient 

type ClustersClient struct {
	BaseClient
}

ClustersClient is the azure Event Hubs Cluster client for managing Event Hubs Cluster resources.

func NewClustersClient 

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI 

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient client.

func (ClustersClient) Get 

func (client ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

Get gets the resource description of the specified Event Hubs Cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ClustersClient) GetPreparer 

func (client ClustersClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder 

func (client ClustersClient) GetResponder(resp *http.Response) (result Cluster, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ClustersClient) GetSender 

func (client ClustersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) ListByResourceGroup 

func (client ClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ClusterListResultPage, err error)

ListByResourceGroup lists the available Event Hubs Clusters within an ARM resource group. Parameters: resourceGroupName - name of the resource group within the Azure subscription.

func (ClustersClient) ListByResourceGroupComplete 

func (client ClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ClusterListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ClustersClient) ListByResourceGroupPreparer 

func (client ClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ClustersClient) ListByResourceGroupResponder 

func (client ClustersClient) ListByResourceGroupResponder(resp *http.Response) (result ClusterListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ClustersClient) ListByResourceGroupSender 

func (client ClustersClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Patch 

func (client ClustersClient) Patch(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (result ClustersPatchFuture, err error)

Patch modifies mutable properties on the Event Hubs Cluster. This operation is idempotent. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster. parameters - the properties of the Event Hubs Cluster which should be updated.

func (ClustersClient) PatchPreparer 

func (client ClustersClient) PatchPreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (ClustersClient) PatchResponder 

func (client ClustersClient) PatchResponder(resp *http.Response) (result Cluster, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (ClustersClient) PatchSender 

func (client ClustersClient) PatchSender(req *http.Request) (future ClustersPatchFuture, err error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

type ClustersPatchFuture 

type ClustersPatchFuture struct {
	azure.Future
}

ClustersPatchFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersPatchFuture) Result 

func (future *ClustersPatchFuture) Result(client ClustersClient) (c Cluster, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ConfigurationClient 

type ConfigurationClient struct {
	BaseClient
}

ConfigurationClient is the azure Event Hubs Cluster client for managing Event Hubs Cluster resources.

func NewConfigurationClient 

func NewConfigurationClient(subscriptionID string) ConfigurationClient

NewConfigurationClient creates an instance of the ConfigurationClient client.

func NewConfigurationClientWithBaseURI 

func NewConfigurationClientWithBaseURI(baseURI string, subscriptionID string) ConfigurationClient

NewConfigurationClientWithBaseURI creates an instance of the ConfigurationClient client.

func (ConfigurationClient) Get 

func (client ConfigurationClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result ClusterQuotaConfigurationProperties, err error)

Get get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ConfigurationClient) GetPreparer 

func (client ConfigurationClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ConfigurationClient) GetResponder 

func (client ConfigurationClient) GetResponder(resp *http.Response) (result ClusterQuotaConfigurationProperties, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ConfigurationClient) GetSender 

func (client ConfigurationClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ConfigurationClient) Patch 

func (client ConfigurationClient) Patch(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterQuotaConfigurationProperties) (result ClusterQuotaConfigurationProperties, err error)

Patch replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster. parameters - parameters for creating an Event Hubs Cluster resource.

func (ConfigurationClient) PatchPreparer 

func (client ConfigurationClient) PatchPreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterQuotaConfigurationProperties) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (ConfigurationClient) PatchResponder 

func (client ConfigurationClient) PatchResponder(resp *http.Response) (result ClusterQuotaConfigurationProperties, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (ConfigurationClient) PatchSender 

func (client ConfigurationClient) PatchSender(req *http.Request) (*http.Response, error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

type ErrorResponse 

type ErrorResponse struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation a Event Hub REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.EventHub
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Invoice, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Event Hub operations supported by the Microsoft.EventHub resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Event Hubs Cluster client for managing Event Hubs Cluster resources.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available Event Hub REST API operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Resource 

type Resource struct {
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
}

Resource the Resource definition

type TrackedResource 

type TrackedResource struct {
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
}

TrackedResource definition of an Azure resource.

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

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.