models

package
v0.94.0 Latest Latest
Warning

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

Go to latest
Published: May 1, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudiamPrincipal

type CloudiamPrincipal struct {

	// group is a group principal.
	Group *IamGroup `json:"group,omitempty"`

	// group_ids is a list of IDs of the HCP groups that this principal is a
	// member of.
	GroupIds []string `json:"group_ids"`

	// id is the identifier for the principal.
	ID string `json:"id,omitempty"`

	// service is a service principal.
	Service *CloudiamServicePrincipal `json:"service,omitempty"`

	// type is the type of the principal.
	Type *IamPrincipalType `json:"type,omitempty"`

	// user is a user principal.
	User *CloudiamUserPrincipal `json:"user,omitempty"`
}

CloudiamPrincipal Principal is the common wrapper for our different types of principals.

swagger:model cloudiamPrincipal

func (*CloudiamPrincipal) ContextValidate

func (m *CloudiamPrincipal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cloudiam principal based on the context it is used

func (*CloudiamPrincipal) MarshalBinary

func (m *CloudiamPrincipal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudiamPrincipal) UnmarshalBinary

func (m *CloudiamPrincipal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudiamPrincipal) Validate

func (m *CloudiamPrincipal) Validate(formats strfmt.Registry) error

Validate validates this cloudiam principal

type CloudiamServicePrincipal

type CloudiamServicePrincipal struct {

	// created_at is when the service principal was created.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// id is the UUID identifier for this service principal.
	ID string `json:"id,omitempty"`

	// name is the name for this service principal.
	Name string `json:"name,omitempty"`

	// organization_id is the UUID identifier of the HCP organization that this
	// service principal belongs to.
	OrganizationID string `json:"organization_id,omitempty"`

	// project_id is the UUID identifier of the HCP project that this
	// project service principal belongs to.
	ProjectID string `json:"project_id,omitempty"`

	// resource_name is the resource name for this service principal.
	ResourceName string `json:"resource_name,omitempty"`
}

CloudiamServicePrincipal ServicePrincipal is the HCP identity for a machine user.

swagger:model cloudiamServicePrincipal

func (*CloudiamServicePrincipal) ContextValidate

func (m *CloudiamServicePrincipal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this cloudiam service principal based on context it is used

func (*CloudiamServicePrincipal) MarshalBinary

func (m *CloudiamServicePrincipal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudiamServicePrincipal) UnmarshalBinary

func (m *CloudiamServicePrincipal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudiamServicePrincipal) Validate

func (m *CloudiamServicePrincipal) Validate(formats strfmt.Registry) error

Validate validates this cloudiam service principal

type CloudiamUserPrincipal

type CloudiamUserPrincipal struct {

	// email is the unique email address of this user.
	Email string `json:"email,omitempty"`

	// full_name is the name of the user, as provided by Auth0.
	FullName string `json:"full_name,omitempty"`

	// id is the UUID public identifier for a user principal. It is safe
	// to share this value with external users, and it should be how user principals
	// are commonly identified also within our platform.
	ID string `json:"id,omitempty"`

	// identity_type is the identity type for this user.
	IdentityType *UserPrincipalIdentityType `json:"identity_type,omitempty"`

	// identity_types is an array of the identity types for this user.
	IdentityTypes []*UserPrincipalIdentityType `json:"identity_types"`

	// scim_synchronized denotes the user principal was synchronized from a
	// customer's IdP using SCIM.
	ScimSynchronized bool `json:"scim_synchronized,omitempty"`

	// subject is the user ID from the authenticating IDP (e.g. Hydra).
	Subject string `json:"subject,omitempty"`
}

CloudiamUserPrincipal UserPrincipal represents a human user of our platform.

swagger:model cloudiamUserPrincipal

func (*CloudiamUserPrincipal) ContextValidate

func (m *CloudiamUserPrincipal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cloudiam user principal based on the context it is used

func (*CloudiamUserPrincipal) MarshalBinary

func (m *CloudiamUserPrincipal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudiamUserPrincipal) UnmarshalBinary

func (m *CloudiamUserPrincipal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudiamUserPrincipal) Validate

func (m *CloudiamUserPrincipal) Validate(formats strfmt.Registry) error

Validate validates this cloudiam user principal

type CloudlocationLocation

type CloudlocationLocation struct {

	// organization_id is the id of the organization.
	OrganizationID string `json:"organization_id,omitempty"`

	// project_id is the projects id.
	ProjectID string `json:"project_id,omitempty"`

	// region is the region that the resource is located in. It is
	// optional if the object being referenced is a global object.
	Region *LocationRegion `json:"region,omitempty"`
}

CloudlocationLocation Location represents a target for an operation in HCP.

swagger:model cloudlocationLocation

func (*CloudlocationLocation) ContextValidate

func (m *CloudlocationLocation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cloudlocation location based on the context it is used

func (*CloudlocationLocation) MarshalBinary

func (m *CloudlocationLocation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudlocationLocation) UnmarshalBinary

func (m *CloudlocationLocation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudlocationLocation) Validate

func (m *CloudlocationLocation) Validate(formats strfmt.Registry) error

Validate validates this cloudlocation location

type CloudlogService20210330Filter

type CloudlogService20210330Filter struct {

	// dataplane_audit_filter represents a data plane audit filter.
	DataplaneAuditFilter *LogService20210330DataPlaneAuditFilter `json:"dataplane_audit_filter,omitempty"`

	// organization_filter represents an org level filter.
	OrganizationFilter *LogService20210330OrganizationFilter `json:"organization_filter,omitempty"`
}

CloudlogService20210330Filter Filter represents the object that associates or excludes resources with a destination. Depending on the type of resource log the filter determines if the log should be streamed to the configured destination.

swagger:model cloudlog_service_20210330Filter

func (*CloudlogService20210330Filter) ContextValidate

func (m *CloudlogService20210330Filter) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cloudlog service 20210330 filter based on the context it is used

func (*CloudlogService20210330Filter) MarshalBinary

func (m *CloudlogService20210330Filter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudlogService20210330Filter) UnmarshalBinary

func (m *CloudlogService20210330Filter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudlogService20210330Filter) Validate

func (m *CloudlogService20210330Filter) Validate(formats strfmt.Registry) error

Validate validates this cloudlog service 20210330 filter

type CloudlogService20210330Principal

type CloudlogService20210330Principal struct {

	// service has information about the service principal in case one was used
	// to perform the action.
	Service *LogService20210330PrincipalServicePrincipal `json:"service,omitempty"`

	// type indicates what kind of principal performed the action.
	Type *LogService20210330PrincipalType `json:"type,omitempty"`

	// user has information about the user in case of user-triggered actions.
	User *LogService20210330PrincipalUserPrincipal `json:"user,omitempty"`
}

CloudlogService20210330Principal Principal contains information about the person or process who caused a control-plane event.

swagger:model cloudlog_service_20210330Principal

func (*CloudlogService20210330Principal) ContextValidate

func (m *CloudlogService20210330Principal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cloudlog service 20210330 principal based on the context it is used

func (*CloudlogService20210330Principal) MarshalBinary

func (m *CloudlogService20210330Principal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CloudlogService20210330Principal) UnmarshalBinary

func (m *CloudlogService20210330Principal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CloudlogService20210330Principal) Validate

Validate validates this cloudlog service 20210330 principal

type IamGroup

type IamGroup struct {

	// created_at is when the group was created.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// description is a description of the group.
	Description string `json:"description,omitempty"`

	// display_name is the user-specified display name of the group.
	DisplayName string `json:"display_name,omitempty"`

	// member_count is the count of members in the group.
	// We use Int32Value to make sure we return nil instead of 0 if we don't have a member count
	MemberCount int32 `json:"member_count,omitempty"`

	// resource_id is the principal ID of the group.
	ResourceID string `json:"resource_id,omitempty"`

	// resource_name is the name of the group.
	ResourceName string `json:"resource_name,omitempty"`

	// scim_synchronized denotes the group was synchronized from an upstream IdP using SCIM.
	ScimSynchronized bool `json:"scim_synchronized,omitempty"`

	// updated_at is when the group was last updated.
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}

IamGroup iam group

swagger:model iamGroup

func (*IamGroup) ContextValidate

func (m *IamGroup) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this iam group based on context it is used

func (*IamGroup) MarshalBinary

func (m *IamGroup) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IamGroup) UnmarshalBinary

func (m *IamGroup) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IamGroup) Validate

func (m *IamGroup) Validate(formats strfmt.Registry) error

Validate validates this iam group

type IamPrincipalType

type IamPrincipalType string

IamPrincipalType PrincipalType represents the possible types of principals.

  • PRINCIPAL_TYPE_UNSPECIFIED: PRINCIPAL_TYPE_UNSPECIFIED is the default value.
  • PRINCIPAL_TYPE_USER: PRINCIPAL_TYPE_USER is the user principal type.
  • PRINCIPAL_TYPE_SERVICE: PRINCIPAL_TYPE_SERVICE is the service principal type.
  • PRINCIPAL_TYPE_GROUP: PRINCIPAL_TYPE_GROUP is the group principal type.
  • PRINCIPAL_TYPE_INTERNAL_OPERATOR: PRINCIPAL_TYPE_INTERNAL_OPERATOR is the internal operator principal type.

swagger:model iamPrincipalType

const (

	// IamPrincipalTypePRINCIPALTYPEUNSPECIFIED captures enum value "PRINCIPAL_TYPE_UNSPECIFIED"
	IamPrincipalTypePRINCIPALTYPEUNSPECIFIED IamPrincipalType = "PRINCIPAL_TYPE_UNSPECIFIED"

	// IamPrincipalTypePRINCIPALTYPEUSER captures enum value "PRINCIPAL_TYPE_USER"
	IamPrincipalTypePRINCIPALTYPEUSER IamPrincipalType = "PRINCIPAL_TYPE_USER"

	// IamPrincipalTypePRINCIPALTYPESERVICE captures enum value "PRINCIPAL_TYPE_SERVICE"
	IamPrincipalTypePRINCIPALTYPESERVICE IamPrincipalType = "PRINCIPAL_TYPE_SERVICE"

	// IamPrincipalTypePRINCIPALTYPEGROUP captures enum value "PRINCIPAL_TYPE_GROUP"
	IamPrincipalTypePRINCIPALTYPEGROUP IamPrincipalType = "PRINCIPAL_TYPE_GROUP"

	// IamPrincipalTypePRINCIPALTYPEINTERNALOPERATOR captures enum value "PRINCIPAL_TYPE_INTERNAL_OPERATOR"
	IamPrincipalTypePRINCIPALTYPEINTERNALOPERATOR IamPrincipalType = "PRINCIPAL_TYPE_INTERNAL_OPERATOR"
)

func NewIamPrincipalType

func NewIamPrincipalType(value IamPrincipalType) *IamPrincipalType

func (IamPrincipalType) ContextValidate

func (m IamPrincipalType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this iam principal type based on context it is used

func (IamPrincipalType) Pointer

func (m IamPrincipalType) Pointer() *IamPrincipalType

Pointer returns a pointer to a freshly-allocated IamPrincipalType.

func (IamPrincipalType) Validate

func (m IamPrincipalType) Validate(formats strfmt.Registry) error

Validate validates this iam principal type

type LocationLink struct {

	// description is a human-friendly description for this link. This is
	// used primarily for informational purposes such as error messages.
	Description string `json:"description,omitempty"`

	// id is the identifier for this resource.
	ID string `json:"id,omitempty"`

	// location is the location where this resource is.
	Location *CloudlocationLocation `json:"location,omitempty"`

	// type is the unique type of the resource. Each service publishes a
	// unique set of types. The type value is recommended to be formatted
	// in "<org>.<type>" such as "hashicorp.hvn". This is to prevent conflicts
	// in the future, but any string value will work.
	Type string `json:"type,omitempty"`

	// uuid is the unique UUID for this resource.
	UUID string `json:"uuid,omitempty"`
}

LocationLink Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

swagger:model locationLink

func (*LocationLink) ContextValidate

func (m *LocationLink) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location link based on the context it is used

func (*LocationLink) MarshalBinary

func (m *LocationLink) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationLink) UnmarshalBinary

func (m *LocationLink) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationLink) Validate

func (m *LocationLink) Validate(formats strfmt.Registry) error

Validate validates this location link

type LocationRegion

type LocationRegion struct {

	// provider is the named cloud provider ("aws", "gcp", "azure")
	Provider string `json:"provider,omitempty"`

	// region is the cloud region ("us-west1", "us-east1")
	Region string `json:"region,omitempty"`
}

LocationRegion Region identifies a Cloud data-plane region.

swagger:model locationRegion

func (*LocationRegion) ContextValidate

func (m *LocationRegion) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this location region based on context it is used

func (*LocationRegion) MarshalBinary

func (m *LocationRegion) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationRegion) UnmarshalBinary

func (m *LocationRegion) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationRegion) Validate

func (m *LocationRegion) Validate(formats strfmt.Registry) error

Validate validates this location region

type LogService20210330Action

type LogService20210330Action string

LogService20210330Action Action is a classification for Control-Plane actions.

swagger:model log_service_20210330Action

const (

	// LogService20210330ActionUNSET captures enum value "UNSET"
	LogService20210330ActionUNSET LogService20210330Action = "UNSET"

	// LogService20210330ActionREAD captures enum value "READ"
	LogService20210330ActionREAD LogService20210330Action = "READ"

	// LogService20210330ActionCREATE captures enum value "CREATE"
	LogService20210330ActionCREATE LogService20210330Action = "CREATE"

	// LogService20210330ActionUPDATE captures enum value "UPDATE"
	LogService20210330ActionUPDATE LogService20210330Action = "UPDATE"

	// LogService20210330ActionDELETE captures enum value "DELETE"
	LogService20210330ActionDELETE LogService20210330Action = "DELETE"
)

func (LogService20210330Action) ContextValidate

func (m LogService20210330Action) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 action based on context it is used

func (LogService20210330Action) Pointer

Pointer returns a pointer to a freshly-allocated LogService20210330Action.

func (LogService20210330Action) Validate

func (m LogService20210330Action) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 action

type LogService20210330AuditFilterScope

type LogService20210330AuditFilterScope struct {

	// enabled_for_all_resources dictates that the scope applies to all resources under the umbrella of this destination.
	EnabledForAllResources bool `json:"enabled_for_all_resources,omitempty"`

	// resource represents the resource to which to tie the scope to.
	Resource *LocationLink `json:"resource,omitempty"`
}

LogService20210330AuditFilterScope AuditFilterScope represents the scope to which the filter applies for audit log events.

swagger:model log_service_20210330AuditFilterScope

func (*LogService20210330AuditFilterScope) ContextValidate

func (m *LogService20210330AuditFilterScope) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 audit filter scope based on the context it is used

func (*LogService20210330AuditFilterScope) MarshalBinary

func (m *LogService20210330AuditFilterScope) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330AuditFilterScope) UnmarshalBinary

func (m *LogService20210330AuditFilterScope) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330AuditFilterScope) Validate

Validate validates this log service 20210330 audit filter scope

type LogService20210330AuthenticationInfo

type LogService20210330AuthenticationInfo struct {

	// principal is the authenticated principal as returned by
	// iam.GetCurrentPrincipal(). This can be a user, service, or an internal
	// operator principal.
	Principal *CloudiamPrincipal `json:"principal,omitempty"`

	// service_principal_delegation_chain store the chain of assumed principals
	// leading up to the current principal. The order of principals will be in the
	// order the identities were assumed.
	ServicePrincipalDelegationChain []*LogService20210330ServicePrincipalDelegationInfo `json:"service_principal_delegation_chain"`
}

LogService20210330AuthenticationInfo AuthenticationInfo contains information about the person or process who caused a control-plane event.

swagger:model log_service_20210330AuthenticationInfo

func (*LogService20210330AuthenticationInfo) ContextValidate

func (m *LogService20210330AuthenticationInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 authentication info based on the context it is used

func (*LogService20210330AuthenticationInfo) MarshalBinary

func (m *LogService20210330AuthenticationInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330AuthenticationInfo) UnmarshalBinary

func (m *LogService20210330AuthenticationInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330AuthenticationInfo) Validate

Validate validates this log service 20210330 authentication info

type LogService20210330Authorization

type LogService20210330Authorization struct {

	// extra_properties represents any extra headers that should be sent as headers when streaming to the destination.
	ExtraProperties interface{} `json:"extra_properties,omitempty"`

	// header represents the header key of an http header.
	Header string `json:"header,omitempty"`

	// value represents the header value of an http header.
	Value string `json:"value,omitempty"`
}

LogService20210330Authorization Authorization represents an http authorization header structure.

swagger:model log_service_20210330Authorization

func (*LogService20210330Authorization) ContextValidate

func (m *LogService20210330Authorization) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 authorization based on context it is used

func (*LogService20210330Authorization) MarshalBinary

func (m *LogService20210330Authorization) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330Authorization) UnmarshalBinary

func (m *LogService20210330Authorization) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330Authorization) Validate

Validate validates this log service 20210330 authorization

type LogService20210330AuthorizationInfo

type LogService20210330AuthorizationInfo struct {

	// organization_id is the ID of the organization the permission was granted
	// on.
	OrganizationID string `json:"organization_id,omitempty"`

	// permissions is the list of permissions required to perform the action.
	Permissions []string `json:"permissions"`

	// project_id is the ID of the project the permission was granted on.
	ProjectID string `json:"project_id,omitempty"`

	// resource_id is the ID of the resource the permission was granted on.
	ResourceID string `json:"resource_id,omitempty"`
}

LogService20210330AuthorizationInfo AuthorizationInfo contains information about the permissions granted to the person triggering a control-plane event.

swagger:model log_service_20210330AuthorizationInfo

func (*LogService20210330AuthorizationInfo) ContextValidate

func (m *LogService20210330AuthorizationInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 authorization info based on context it is used

func (*LogService20210330AuthorizationInfo) MarshalBinary

func (m *LogService20210330AuthorizationInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330AuthorizationInfo) UnmarshalBinary

func (m *LogService20210330AuthorizationInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330AuthorizationInfo) Validate

Validate validates this log service 20210330 authorization info

type LogService20210330CloudwatchLogsProvider

type LogService20210330CloudwatchLogsProvider struct {

	// external_id represents the external_id to provide when assuming the aws IAM role.
	ExternalID string `json:"external_id,omitempty"`

	// log_group_name represents the name of the log group.
	LogGroupName string `json:"log_group_name,omitempty"`

	// log_stream_name represents the name of the log stream.
	LogStreamName string `json:"log_stream_name,omitempty"`

	// region represents the region the cloudwatch log is set up for.
	Region string `json:"region,omitempty"`

	// role_arn is the role_arn that will be assumed to stream logs.
	RoleArn string `json:"role_arn,omitempty"`
}

LogService20210330CloudwatchLogsProvider CloudwatchLogsProvider represents the necessary information to configure a cloudwatch destination.

swagger:model log_service_20210330CloudwatchLogsProvider

func (*LogService20210330CloudwatchLogsProvider) ContextValidate

ContextValidate validates this log service 20210330 cloudwatch logs provider based on context it is used

func (*LogService20210330CloudwatchLogsProvider) MarshalBinary

func (m *LogService20210330CloudwatchLogsProvider) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330CloudwatchLogsProvider) UnmarshalBinary

func (m *LogService20210330CloudwatchLogsProvider) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330CloudwatchLogsProvider) Validate

Validate validates this log service 20210330 cloudwatch logs provider

type LogService20210330ControlPlaneEvent

type LogService20210330ControlPlaneEvent struct {

	// Action classifies the performed action.
	Action *LogService20210330Action `json:"action,omitempty"`

	// authentication_info holds information about the authenticated principal.
	AuthenticationInfo *LogService20210330AuthenticationInfo `json:"authentication_info,omitempty"`

	// authorization_info describes what permissions were required to perform
	// the action and whether the authenticated principal was granted these.
	AuthorizationInfo []*LogService20210330AuthorizationInfo `json:"authorization_info"`

	// description describes the event in a human comprehensible manner.
	Description string `json:"description,omitempty"`

	// metadata is action-specific data about the request, response, or other
	// information associated with the current audited event.
	Metadata interface{} `json:"metadata,omitempty"`

	// operation_info describes the operation this event is part of.
	OperationInfo *LogService20210330OperationInfo `json:"operation_info,omitempty"`

	// principal holds information about the principal that performed the action.
	Principal *CloudlogService20210330Principal `json:"principal,omitempty"`

	// request_info contains information about the request triggering this event.
	RequestInfo *LogService20210330RequestInfo `json:"request_info,omitempty"`

	// service_principal_delegation_chain store the chain of assumed principals
	// leading up to the current principal. The order of principals will be in the
	// order the identities were assumed.
	ServicePrincipalDelegationChain []*LogService20210330ServicePrincipalDelegationInfo `json:"service_principal_delegation_chain"`

	// status_code contains the status code the audited action resulted in. This
	// is the string representation of the event's status.code.
	StatusCode string `json:"status_code,omitempty"`
}

LogService20210330ControlPlaneEvent ControlPlaneEvent captures an action that happened on the HCP control-plane.

swagger:model log_service_20210330ControlPlaneEvent

func (*LogService20210330ControlPlaneEvent) ContextValidate

func (m *LogService20210330ControlPlaneEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 control plane event based on the context it is used

func (*LogService20210330ControlPlaneEvent) MarshalBinary

func (m *LogService20210330ControlPlaneEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330ControlPlaneEvent) UnmarshalBinary

func (m *LogService20210330ControlPlaneEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330ControlPlaneEvent) Validate

Validate validates this log service 20210330 control plane event

type LogService20210330CreateArchiveRequest

type LogService20210330CreateArchiveRequest struct {

	// end defines the latest point in time from which to retrieve log entries.
	// Format: date-time
	ArchiveEndTime strfmt.DateTime `json:"archive_end_time,omitempty"`

	// start defines the earliest point in time from which to retrieve log entries.
	// Format: date-time
	ArchiveStartTime strfmt.DateTime `json:"archive_start_time,omitempty"`

	// resource identifies the resource related to the log entry if one exists.
	Resource *LocationLink `json:"resource,omitempty"`
}

LogService20210330CreateArchiveRequest ArchiveRequest represents a request to create an archive for a given resource.

swagger:model log_service_20210330CreateArchiveRequest

func (*LogService20210330CreateArchiveRequest) ContextValidate

ContextValidate validate this log service 20210330 create archive request based on the context it is used

func (*LogService20210330CreateArchiveRequest) MarshalBinary

func (m *LogService20210330CreateArchiveRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330CreateArchiveRequest) UnmarshalBinary

func (m *LogService20210330CreateArchiveRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330CreateArchiveRequest) Validate

Validate validates this log service 20210330 create archive request

type LogService20210330CreateArchiveResponse

type LogService20210330CreateArchiveResponse struct {

	// id represents the archive record id for the related request.
	ID string `json:"id,omitempty"`
}

LogService20210330CreateArchiveResponse ArchiveResponse represents the response returned from an archive request.

swagger:model log_service_20210330CreateArchiveResponse

func (*LogService20210330CreateArchiveResponse) ContextValidate

ContextValidate validates this log service 20210330 create archive response based on context it is used

func (*LogService20210330CreateArchiveResponse) MarshalBinary

func (m *LogService20210330CreateArchiveResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330CreateArchiveResponse) UnmarshalBinary

func (m *LogService20210330CreateArchiveResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330CreateArchiveResponse) Validate

Validate validates this log service 20210330 create archive response

type LogService20210330CreateStreamingDestinationFilterRequest

type LogService20210330CreateStreamingDestinationFilterRequest struct {

	// audit_filter represents a data plane audit filter.
	DataplaneAuditFilter *LogService20210330DataPlaneAuditFilter `json:"dataplane_audit_filter,omitempty"`

	// destination_id is represents the ID of destination we want to create the filter for.
	DestinationID string `json:"destination_id,omitempty"`

	// organization_filter represents an org level filter.
	OrganizationFilter *LogService20210330OrganizationFilter `json:"organization_filter,omitempty"`

	// organization id
	OrganizationID string `json:"organization_id,omitempty"`
}

LogService20210330CreateStreamingDestinationFilterRequest CreateStreamingDestinationFilterRequest represents a reqeust to add a filter to a destination record. We don't require the project ID because we will pull it from the destination record.

swagger:model log_service_20210330CreateStreamingDestinationFilterRequest

func (*LogService20210330CreateStreamingDestinationFilterRequest) ContextValidate

ContextValidate validate this log service 20210330 create streaming destination filter request based on the context it is used

func (*LogService20210330CreateStreamingDestinationFilterRequest) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationFilterRequest) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationFilterRequest) Validate

Validate validates this log service 20210330 create streaming destination filter request

type LogService20210330CreateStreamingDestinationRequest

type LogService20210330CreateStreamingDestinationRequest struct {

	// cloudwatchlogs_provider represents a cloudwatch provider.
	CloudwatchlogsProvider *LogService20210330CloudwatchLogsProvider `json:"cloudwatchlogs_provider,omitempty"`

	// datadog_provider represents a datadog provider.
	DatadogProvider *LogService20210330DatadogProvider `json:"datadog_provider,omitempty"`

	// destination_name represents the human readable name of a destination
	DestinationName string `json:"destination_name,omitempty"`

	// location is the location (orgID - projectID) the streaming destination will belong to.
	Location *CloudlocationLocation `json:"location,omitempty"`

	// config is the object that stores information about the destination. URL, Authentication, etc...
	// source_channel denotes where the create request was made from. For example terraform or the hcp ui.
	SourceChannel string `json:"source_channel,omitempty"`

	// splunk_cloud_provider represents a splunk provider.
	SplunkCloudProvider *LogService20210330SplunkCloudProvider `json:"splunk_cloud_provider,omitempty"`
}

LogService20210330CreateStreamingDestinationRequest CreateStreamingDestinationRequest represents the request to create a new destination record.

swagger:model log_service_20210330CreateStreamingDestinationRequest

func (*LogService20210330CreateStreamingDestinationRequest) ContextValidate

ContextValidate validate this log service 20210330 create streaming destination request based on the context it is used

func (*LogService20210330CreateStreamingDestinationRequest) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationRequest) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationRequest) Validate

Validate validates this log service 20210330 create streaming destination request

type LogService20210330CreateStreamingDestinationResponse

type LogService20210330CreateStreamingDestinationResponse struct {

	// destination represents the destination that was created from the request.
	Destination *LogService20210330Destination `json:"destination,omitempty"`
}

LogService20210330CreateStreamingDestinationResponse CreateStreamingDestinationResponse is the response of the create destination request

swagger:model log_service_20210330CreateStreamingDestinationResponse

func (*LogService20210330CreateStreamingDestinationResponse) ContextValidate

ContextValidate validate this log service 20210330 create streaming destination response based on the context it is used

func (*LogService20210330CreateStreamingDestinationResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330CreateStreamingDestinationResponse) Validate

Validate validates this log service 20210330 create streaming destination response

type LogService20210330DataPlaneAuditFilter

type LogService20210330DataPlaneAuditFilter struct {

	// id represents the id of the destination filter
	ID string `json:"id,omitempty"`

	// include_resources represents resources that should have data plane audit logs streamed.
	IncludeResources []*LogService20210330AuditFilterScope `json:"include_resources"`
}

LogService20210330DataPlaneAuditFilter DataPlaneAuditFilter represents a filter that regulates what resources and resource types should have data plane audit logs streamed.

swagger:model log_service_20210330DataPlaneAuditFilter

func (*LogService20210330DataPlaneAuditFilter) ContextValidate

ContextValidate validate this log service 20210330 data plane audit filter based on the context it is used

func (*LogService20210330DataPlaneAuditFilter) MarshalBinary

func (m *LogService20210330DataPlaneAuditFilter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330DataPlaneAuditFilter) UnmarshalBinary

func (m *LogService20210330DataPlaneAuditFilter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330DataPlaneAuditFilter) Validate

Validate validates this log service 20210330 data plane audit filter

type LogService20210330DatadogProvider

type LogService20210330DatadogProvider struct {

	// authorization represents the authorization information sent with each request when streaming to the datadog endpoint.
	Authorization *LogService20210330Authorization `json:"authorization,omitempty"`

	// endpoint represents the datadog endpoint to which to stream logs.
	Endpoint string `json:"endpoint,omitempty"`
}

LogService20210330DatadogProvider DatadogProvider represents the necessary information to configure a datadog destination.

swagger:model log_service_20210330DatadogProvider

func (*LogService20210330DatadogProvider) ContextValidate

func (m *LogService20210330DatadogProvider) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 datadog provider based on the context it is used

func (*LogService20210330DatadogProvider) MarshalBinary

func (m *LogService20210330DatadogProvider) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330DatadogProvider) UnmarshalBinary

func (m *LogService20210330DatadogProvider) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330DatadogProvider) Validate

Validate validates this log service 20210330 datadog provider

type LogService20210330DeleteStreamingDestinationResponse

type LogService20210330DeleteStreamingDestinationResponse struct {

	// success represents if the delete request was successful or not.
	Success bool `json:"success,omitempty"`
}

LogService20210330DeleteStreamingDestinationResponse DeleteStreamingDestinationResponse represents a response for the delete destination request.

swagger:model log_service_20210330DeleteStreamingDestinationResponse

func (*LogService20210330DeleteStreamingDestinationResponse) ContextValidate

ContextValidate validates this log service 20210330 delete streaming destination response based on context it is used

func (*LogService20210330DeleteStreamingDestinationResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330DeleteStreamingDestinationResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330DeleteStreamingDestinationResponse) Validate

Validate validates this log service 20210330 delete streaming destination response

type LogService20210330Destination

type LogService20210330Destination struct {

	// cloudwatchlogs_provider represents a cloudwatch provider.
	CloudwatchlogsProvider *LogService20210330CloudwatchLogsProvider `json:"cloudwatchlogs_provider,omitempty"`

	// datadog_provider represents a datadog provider.
	DatadogProvider *LogService20210330DatadogProvider `json:"datadog_provider,omitempty"`

	// endpoint represents the endpoint that the destination is configured to stream to
	Endpoint string `json:"endpoint,omitempty"`

	// filter represents the filters that are attached to the destination record.
	Filter *CloudlogService20210330Filter `json:"filter,omitempty"`

	// in_error represents if the HCP platform is currently failing to stream to the destination.
	InError bool `json:"in_error,omitempty"`

	// last_error_message represents the error message from the response of the last streaming request sent to the destination.
	LastErrorMessage string `json:"last_error_message,omitempty"`

	// name represents the human readable name of a destination
	Name string `json:"name,omitempty"`

	// resource represents the destination record in the form of an HCP resource.
	Resource *LocationLink `json:"resource,omitempty"`

	// splunk_cloud_provider represents a splunk cloud provider.
	SplunkCloudProvider *LogService20210330SplunkCloudProvider `json:"splunk_cloud_provider,omitempty"`

	// status destination status field error/pending/success
	Status string `json:"status,omitempty"`
}

LogService20210330Destination Destination represents a destination to which to stream log events to.

swagger:model log_service_20210330Destination

func (*LogService20210330Destination) ContextValidate

func (m *LogService20210330Destination) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 destination based on the context it is used

func (*LogService20210330Destination) MarshalBinary

func (m *LogService20210330Destination) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330Destination) UnmarshalBinary

func (m *LogService20210330Destination) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330Destination) Validate

func (m *LogService20210330Destination) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 destination

type LogService20210330EventType

type LogService20210330EventType string

LogService20210330EventType log service 20210330 event type

swagger:model log_service_20210330EventType

const (

	// LogService20210330EventTypeEVENTTYPEUNSET captures enum value "EVENT_TYPE_UNSET"
	LogService20210330EventTypeEVENTTYPEUNSET LogService20210330EventType = "EVENT_TYPE_UNSET"

	// LogService20210330EventTypeEVENTTYPEAUDITLOG captures enum value "EVENT_TYPE_AUDIT_LOG"
	LogService20210330EventTypeEVENTTYPEAUDITLOG LogService20210330EventType = "EVENT_TYPE_AUDIT_LOG"

	// LogService20210330EventTypeEVENTTYPESERVERLOGSTDOUT captures enum value "EVENT_TYPE_SERVER_LOG_STDOUT"
	LogService20210330EventTypeEVENTTYPESERVERLOGSTDOUT LogService20210330EventType = "EVENT_TYPE_SERVER_LOG_STDOUT"

	// LogService20210330EventTypeEVENTTYPESERVERLOGSTDERR captures enum value "EVENT_TYPE_SERVER_LOG_STDERR"
	LogService20210330EventTypeEVENTTYPESERVERLOGSTDERR LogService20210330EventType = "EVENT_TYPE_SERVER_LOG_STDERR"
)

func (LogService20210330EventType) ContextValidate

func (m LogService20210330EventType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 event type based on context it is used

func (LogService20210330EventType) Pointer

Pointer returns a pointer to a freshly-allocated LogService20210330EventType.

func (LogService20210330EventType) Validate

func (m LogService20210330EventType) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 event type

type LogService20210330GetArchiveResponse

type LogService20210330GetArchiveResponse struct {

	// archive_requested_end_time represents the end time which the archive record was specified.
	// Format: date-time
	ArchiveEndTime strfmt.DateTime `json:"archive_end_time,omitempty"`

	// archive_requested_time represents the time which the archive record was created.
	// Format: date-time
	ArchiveRequestedTime strfmt.DateTime `json:"archive_requested_time,omitempty"`

	// archive_requested_start_time represents the start time which the archive record was specified.
	// Format: date-time
	ArchiveStartTime strfmt.DateTime `json:"archive_start_time,omitempty"`

	// error represents the error returned for an archive.
	Error string `json:"error,omitempty"`

	// id represents the database id of the archive record.
	ID string `json:"id,omitempty"`

	// status represents the status of the archive record.
	Status *LogService20210330Status `json:"status,omitempty"`

	// url represents the url from which to download the archive record.
	URL string `json:"url,omitempty"`

	// url_expiration represents the timestamp of when the url expires.
	// Format: date-time
	URLExpiration strfmt.DateTime `json:"url_expiration,omitempty"`
}

LogService20210330GetArchiveResponse GetArchiveResponse represents the response for an archive request.

swagger:model log_service_20210330GetArchiveResponse

func (*LogService20210330GetArchiveResponse) ContextValidate

func (m *LogService20210330GetArchiveResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 get archive response based on the context it is used

func (*LogService20210330GetArchiveResponse) MarshalBinary

func (m *LogService20210330GetArchiveResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330GetArchiveResponse) UnmarshalBinary

func (m *LogService20210330GetArchiveResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330GetArchiveResponse) Validate

Validate validates this log service 20210330 get archive response

type LogService20210330GetRequest

type LogService20210330GetRequest struct {

	// end defines the latest point in time from which to retrieve log entries.
	// Format: date-time
	End strfmt.DateTime `json:"end,omitempty"`

	// Specifies a page token to use to retrieve the next page.
	NextPageToken string `json:"next_page_token,omitempty"`

	// Specifies the list of per field ordering that should be used for sorting.
	OrderBy []string `json:"order_by"`

	// The max number of results per page that should be returned.
	PageSize int64 `json:"page_size,omitempty"`

	// start defines the earliest point in time from which to retrieve log
	// entries.
	// Format: date-time
	Start strfmt.DateTime `json:"start,omitempty"`

	// streams is the list of Log Streams to query from. At least one Log Stream
	// is required.
	Streams []*LogService20210330LogStream `json:"streams"`
}

LogService20210330GetRequest GetRequest is the request payload processed by the Get RPC.

swagger:model log_service_20210330GetRequest

func (*LogService20210330GetRequest) ContextValidate

func (m *LogService20210330GetRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 get request based on the context it is used

func (*LogService20210330GetRequest) MarshalBinary

func (m *LogService20210330GetRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330GetRequest) UnmarshalBinary

func (m *LogService20210330GetRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330GetRequest) Validate

func (m *LogService20210330GetRequest) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 get request

type LogService20210330GetResponse

type LogService20210330GetResponse struct {

	// entries is the list of log entries matching the request.
	Entries []*LogService20210330LogEntry `json:"entries"`

	// This token allows you to get the next page of results for list requests.
	NextPageToken string `json:"next_page_token,omitempty"`
}

LogService20210330GetResponse GetResponse is the response returned from Get RPCs.

swagger:model log_service_20210330GetResponse

func (*LogService20210330GetResponse) ContextValidate

func (m *LogService20210330GetResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 get response based on the context it is used

func (*LogService20210330GetResponse) MarshalBinary

func (m *LogService20210330GetResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330GetResponse) UnmarshalBinary

func (m *LogService20210330GetResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330GetResponse) Validate

func (m *LogService20210330GetResponse) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 get response

type LogService20210330GetStreamingDestinationResponse

type LogService20210330GetStreamingDestinationResponse struct {

	// destination is the destination record returned from the request
	Destination *LogService20210330Destination `json:"destination,omitempty"`
}

LogService20210330GetStreamingDestinationResponse GetStreamingDestinationResponse represents the response to the get streaming destination request

swagger:model log_service_20210330GetStreamingDestinationResponse

func (*LogService20210330GetStreamingDestinationResponse) ContextValidate

ContextValidate validate this log service 20210330 get streaming destination response based on the context it is used

func (*LogService20210330GetStreamingDestinationResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330GetStreamingDestinationResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330GetStreamingDestinationResponse) Validate

Validate validates this log service 20210330 get streaming destination response

type LogService20210330ListArchiveRecord

type LogService20210330ListArchiveRecord struct {

	// archive_requested_end_time represents the end time which the archive record was specified.
	// Format: date-time
	ArchiveEndTime strfmt.DateTime `json:"archive_end_time,omitempty"`

	// archive_requested_time represents the time which the archive record was created.
	// Format: date-time
	ArchiveRequestedTime strfmt.DateTime `json:"archive_requested_time,omitempty"`

	// archive_requested_start_time represents the start time which the archive record was specified.
	// Format: date-time
	ArchiveStartTime strfmt.DateTime `json:"archive_start_time,omitempty"`

	// error is the potential error that occurred while creating the archive record.
	Error string `json:"error,omitempty"`

	// id represents the database id of the archive record.
	ID string `json:"id,omitempty"`

	// status represents the status of the archive record.
	Status *LogService20210330Status `json:"status,omitempty"`
}

LogService20210330ListArchiveRecord ListArchivedRecord represents a single archive record.

swagger:model log_service_20210330ListArchiveRecord

func (*LogService20210330ListArchiveRecord) ContextValidate

func (m *LogService20210330ListArchiveRecord) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 list archive record based on the context it is used

func (*LogService20210330ListArchiveRecord) MarshalBinary

func (m *LogService20210330ListArchiveRecord) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330ListArchiveRecord) UnmarshalBinary

func (m *LogService20210330ListArchiveRecord) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330ListArchiveRecord) Validate

Validate validates this log service 20210330 list archive record

type LogService20210330ListArchivesResponse

type LogService20210330ListArchivesResponse struct {

	// archives represents the list of archive records that are related to a resource.
	Archives []*LogService20210330ListArchiveRecord `json:"archives"`

	// config_creation_date represents the date when the data plane configuration was created for a resource .
	// Format: date-time
	ConfigCreationDate strfmt.DateTime `json:"config_creation_date,omitempty"`
}

LogService20210330ListArchivesResponse ListArchiveResponse represents the response from the list archive request.

swagger:model log_service_20210330ListArchivesResponse

func (*LogService20210330ListArchivesResponse) ContextValidate

ContextValidate validate this log service 20210330 list archives response based on the context it is used

func (*LogService20210330ListArchivesResponse) MarshalBinary

func (m *LogService20210330ListArchivesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330ListArchivesResponse) UnmarshalBinary

func (m *LogService20210330ListArchivesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330ListArchivesResponse) Validate

Validate validates this log service 20210330 list archives response

type LogService20210330ListStreamingDestinationsForResourceRequest

type LogService20210330ListStreamingDestinationsForResourceRequest struct {

	// resource is the link the streaming destinations are attached to.
	Resource *LocationLink `json:"resource,omitempty"`
}

LogService20210330ListStreamingDestinationsForResourceRequest ListStreamingDestinationsForResourceRequest represents a request to get all destination record for a resources

swagger:model log_service_20210330ListStreamingDestinationsForResourceRequest

func (*LogService20210330ListStreamingDestinationsForResourceRequest) ContextValidate

ContextValidate validate this log service 20210330 list streaming destinations for resource request based on the context it is used

func (*LogService20210330ListStreamingDestinationsForResourceRequest) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsForResourceRequest) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsForResourceRequest) Validate

Validate validates this log service 20210330 list streaming destinations for resource request

type LogService20210330ListStreamingDestinationsForResourceResponse

type LogService20210330ListStreamingDestinationsForResourceResponse struct {

	// destinations are the list of destinations returned.
	Destinations []*LogService20210330Destination `json:"destinations"`
}

LogService20210330ListStreamingDestinationsForResourceResponse ListStreamingDestinationsResponse is the response for the list destination request

swagger:model log_service_20210330ListStreamingDestinationsForResourceResponse

func (*LogService20210330ListStreamingDestinationsForResourceResponse) ContextValidate

ContextValidate validate this log service 20210330 list streaming destinations for resource response based on the context it is used

func (*LogService20210330ListStreamingDestinationsForResourceResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsForResourceResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsForResourceResponse) Validate

Validate validates this log service 20210330 list streaming destinations for resource response

type LogService20210330ListStreamingDestinationsResponse

type LogService20210330ListStreamingDestinationsResponse struct {

	// destinations are the list of destinations returned.
	Destinations []*LogService20210330Destination `json:"destinations"`
}

LogService20210330ListStreamingDestinationsResponse ListStreamingDestinationResponse is the response for the list destination request

swagger:model log_service_20210330ListStreamingDestinationsResponse

func (*LogService20210330ListStreamingDestinationsResponse) ContextValidate

ContextValidate validate this log service 20210330 list streaming destinations response based on the context it is used

func (*LogService20210330ListStreamingDestinationsResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330ListStreamingDestinationsResponse) Validate

Validate validates this log service 20210330 list streaming destinations response

type LogService20210330LogEntry

type LogService20210330LogEntry struct {

	// control_plane_event includes details about an action that happened on the
	// HCP control-plane.
	ControlPlaneEvent *LogService20210330ControlPlaneEvent `json:"control_plane_event,omitempty"`

	// id is the unique identifier of this log entry.
	ID string `json:"id,omitempty"`

	// resource identifies the resource related to the log entry if one exists.
	Resource *LocationLink `json:"resource,omitempty"`

	// service_log_event includes details about an action that happened on the
	// HCP data-plane.
	ServiceLogEvent *LogService20210330ServiceLogEvent `json:"service_log_event,omitempty"`

	// stream identifies the log stream this log entry is part of.
	Stream *LogService20210330LogStream `json:"stream,omitempty"`

	// timestamp is the time this log entry was stored.
	// Format: date-time
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
}

LogService20210330LogEntry LogEntry represents a single log entry that is stored in the Log System.

swagger:model log_service_20210330LogEntry

func (*LogService20210330LogEntry) ContextValidate

func (m *LogService20210330LogEntry) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 log entry based on the context it is used

func (*LogService20210330LogEntry) MarshalBinary

func (m *LogService20210330LogEntry) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330LogEntry) UnmarshalBinary

func (m *LogService20210330LogEntry) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330LogEntry) Validate

func (m *LogService20210330LogEntry) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 log entry

type LogService20210330LogStream

type LogService20210330LogStream struct {

	// organization_id is the UUID of the HCP organization this stream belongs to.
	OrganizationID string `json:"organization_id,omitempty"`

	// project_id is the UUID of the HCP project this stream belongs to.
	// If no project_id is set, this stream belongs to an organization directly.
	ProjectID string `json:"project_id,omitempty"`

	// topic is the logical name of the log stream.
	Topic string `json:"topic,omitempty"`
}

LogService20210330LogStream LogStream identifies a log stream.

swagger:model log_service_20210330LogStream

func (*LogService20210330LogStream) ContextValidate

func (m *LogService20210330LogStream) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 log stream based on context it is used

func (*LogService20210330LogStream) MarshalBinary

func (m *LogService20210330LogStream) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330LogStream) UnmarshalBinary

func (m *LogService20210330LogStream) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330LogStream) Validate

func (m *LogService20210330LogStream) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 log stream

type LogService20210330MatrixResponse

type LogService20210330MatrixResponse struct {

	// values are the matrix values entries returned from loki.
	Values []*LogService20210330MatrixValue `json:"values"`
}

LogService20210330MatrixResponse log service 20210330 matrix response

swagger:model log_service_20210330MatrixResponse

func (*LogService20210330MatrixResponse) ContextValidate

func (m *LogService20210330MatrixResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 matrix response based on the context it is used

func (*LogService20210330MatrixResponse) MarshalBinary

func (m *LogService20210330MatrixResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330MatrixResponse) UnmarshalBinary

func (m *LogService20210330MatrixResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330MatrixResponse) Validate

Validate validates this log service 20210330 matrix response

type LogService20210330MatrixValue

type LogService20210330MatrixValue struct {

	// number is the value in second unix epoch.
	Number string `json:"number,omitempty"`

	// payload is the string representation of the value.
	Payload string `json:"payload,omitempty"`

	// timestamp number value represented as a timestamp
	// Format: date-time
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
}

LogService20210330MatrixValue log service 20210330 matrix value

swagger:model log_service_20210330MatrixValue

func (*LogService20210330MatrixValue) ContextValidate

func (m *LogService20210330MatrixValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 matrix value based on context it is used

func (*LogService20210330MatrixValue) MarshalBinary

func (m *LogService20210330MatrixValue) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330MatrixValue) UnmarshalBinary

func (m *LogService20210330MatrixValue) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330MatrixValue) Validate

func (m *LogService20210330MatrixValue) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 matrix value

type LogService20210330OperationInfo

type LogService20210330OperationInfo struct {

	// operation_id is the ID of the operation.
	OperationID string `json:"operation_id,omitempty"`
}

LogService20210330OperationInfo OperationInfo contains information about the operation a control-plane event is part of.

swagger:model log_service_20210330OperationInfo

func (*LogService20210330OperationInfo) ContextValidate

func (m *LogService20210330OperationInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 operation info based on context it is used

func (*LogService20210330OperationInfo) MarshalBinary

func (m *LogService20210330OperationInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330OperationInfo) UnmarshalBinary

func (m *LogService20210330OperationInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330OperationInfo) Validate

Validate validates this log service 20210330 operation info

type LogService20210330OrganizationFilter

type LogService20210330OrganizationFilter struct {

	// id is the id of the filter.
	ID string `json:"id,omitempty"`
}

LogService20210330OrganizationFilter OrganizationFilter represents an org level filter that will by default stream all logs.

swagger:model log_service_20210330OrganizationFilter

func (*LogService20210330OrganizationFilter) ContextValidate

func (m *LogService20210330OrganizationFilter) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 organization filter based on context it is used

func (*LogService20210330OrganizationFilter) MarshalBinary

func (m *LogService20210330OrganizationFilter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330OrganizationFilter) UnmarshalBinary

func (m *LogService20210330OrganizationFilter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330OrganizationFilter) Validate

Validate validates this log service 20210330 organization filter

type LogService20210330PrincipalServicePrincipal

type LogService20210330PrincipalServicePrincipal struct {

	// internal denotes if the service principal is an internal one that was not created by a user.
	Internal bool `json:"internal,omitempty"`

	// name is the service principal's name.
	Name string `json:"name,omitempty"`

	// organization_id is the ID of the organization the service principal
	// belongs to.
	OrganizationID string `json:"organization_id,omitempty"`
}

LogService20210330PrincipalServicePrincipal ServicePrincipal represents a service principal who performed an action in HCP.

swagger:model log_service_20210330PrincipalServicePrincipal

func (*LogService20210330PrincipalServicePrincipal) ContextValidate

ContextValidate validates this log service 20210330 principal service principal based on context it is used

func (*LogService20210330PrincipalServicePrincipal) MarshalBinary

func (m *LogService20210330PrincipalServicePrincipal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330PrincipalServicePrincipal) UnmarshalBinary

func (m *LogService20210330PrincipalServicePrincipal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330PrincipalServicePrincipal) Validate

Validate validates this log service 20210330 principal service principal

type LogService20210330PrincipalType

type LogService20210330PrincipalType string

LogService20210330PrincipalType Type is the type of the principal.

  • TYPE_USER: TYPE_USER indicates that the action was performed by a user.
  • TYPE_SERVICE: TYPE_SERVICE indicates that the action was performed by a service

principal.

  • TYPE_INTERNAL_OPERATOR: TYPE_INTERNAL_OPERATOR indicates that the action was performed by a

HashiCorp operator.

swagger:model log_service_20210330PrincipalType

const (

	// LogService20210330PrincipalTypeTYPEUSER captures enum value "TYPE_USER"
	LogService20210330PrincipalTypeTYPEUSER LogService20210330PrincipalType = "TYPE_USER"

	// LogService20210330PrincipalTypeTYPESERVICE captures enum value "TYPE_SERVICE"
	LogService20210330PrincipalTypeTYPESERVICE LogService20210330PrincipalType = "TYPE_SERVICE"

	// LogService20210330PrincipalTypeTYPEINTERNALOPERATOR captures enum value "TYPE_INTERNAL_OPERATOR"
	LogService20210330PrincipalTypeTYPEINTERNALOPERATOR LogService20210330PrincipalType = "TYPE_INTERNAL_OPERATOR"
)

func (LogService20210330PrincipalType) ContextValidate

func (m LogService20210330PrincipalType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 principal type based on context it is used

func (LogService20210330PrincipalType) Pointer

Pointer returns a pointer to a freshly-allocated LogService20210330PrincipalType.

func (LogService20210330PrincipalType) Validate

Validate validates this log service 20210330 principal type

type LogService20210330PrincipalUserPrincipal

type LogService20210330PrincipalUserPrincipal struct {

	// email is the user's email address.
	Email string `json:"email,omitempty"`

	// full_name is the user's name.
	FullName string `json:"full_name,omitempty"`
}

LogService20210330PrincipalUserPrincipal UserPrincipal represents a user who performed an action in HCP.

swagger:model log_service_20210330PrincipalUserPrincipal

func (*LogService20210330PrincipalUserPrincipal) ContextValidate

ContextValidate validates this log service 20210330 principal user principal based on context it is used

func (*LogService20210330PrincipalUserPrincipal) MarshalBinary

func (m *LogService20210330PrincipalUserPrincipal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330PrincipalUserPrincipal) UnmarshalBinary

func (m *LogService20210330PrincipalUserPrincipal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330PrincipalUserPrincipal) Validate

Validate validates this log service 20210330 principal user principal

type LogService20210330RequestInfo

type LogService20210330RequestInfo struct {

	// http_client_ip is the IP address of the client sending the HTTP request if
	// there was one.
	HTTPClientIP string `json:"http_client_ip,omitempty"`

	// http_path is the URL path of the respective HTTP request if there was one.
	HTTPPath string `json:"http_path,omitempty"`

	// http_user_agent is the user agent sent as part of the respective HTTP
	// request if there was one.
	HTTPUserAgent string `json:"http_user_agent,omitempty"`

	// http_verb is the HTTP verb/method of the respective HTTP request if there
	// was one.
	HTTPVerb string `json:"http_verb,omitempty"`
}

LogService20210330RequestInfo RequestInfo contains information about the request that triggered an event.

swagger:model log_service_20210330RequestInfo

func (*LogService20210330RequestInfo) ContextValidate

func (m *LogService20210330RequestInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 request info based on context it is used

func (*LogService20210330RequestInfo) MarshalBinary

func (m *LogService20210330RequestInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330RequestInfo) UnmarshalBinary

func (m *LogService20210330RequestInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330RequestInfo) Validate

func (m *LogService20210330RequestInfo) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 request info

type LogService20210330SearchRequest

type LogService20210330SearchRequest struct {

	// end defines the latest point in time from which to retrieve log entries.
	// Defaults to now.
	// Format: date-time
	End strfmt.DateTime `json:"end,omitempty"`

	// Specifies a page token to use to retrieve the next page.
	NextPageToken string `json:"next_page_token,omitempty"`

	// Specifies the list of per field ordering that should be used for sorting.
	OrderBy []string `json:"order_by"`

	// organization_id is the organization id where the query would be ran.
	OrganizationID string `json:"organization_id,omitempty"`

	// The max number of results per page that should be returned.
	PageSize int64 `json:"page_size,omitempty"`

	// query is the LogQL query that will be sent to loki to retrieve results.
	Query string `json:"query,omitempty"`

	// start defines the earliest point in time from which to retrieve log
	// entries. Defaults to now - 5 minutes
	// Format: date-time
	Start strfmt.DateTime `json:"start,omitempty"`
}

LogService20210330SearchRequest log service 20210330 search request

swagger:model log_service_20210330SearchRequest

func (*LogService20210330SearchRequest) ContextValidate

func (m *LogService20210330SearchRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 search request based on context it is used

func (*LogService20210330SearchRequest) MarshalBinary

func (m *LogService20210330SearchRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330SearchRequest) UnmarshalBinary

func (m *LogService20210330SearchRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330SearchRequest) Validate

Validate validates this log service 20210330 search request

type LogService20210330SearchResponse

type LogService20210330SearchResponse struct {

	// matrix are only returned when running a query that computes some value.
	Matrix *LogService20210330MatrixResponse `json:"matrix,omitempty"`

	// This token allows you to get the next page of results for list requests.
	NextPageToken string `json:"next_page_token,omitempty"`

	// streams is a set of all values (logs) over the queried time range.
	Streams *LogService20210330StreamsResponse `json:"streams,omitempty"`
}

LogService20210330SearchResponse log service 20210330 search response

swagger:model log_service_20210330SearchResponse

func (*LogService20210330SearchResponse) ContextValidate

func (m *LogService20210330SearchResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 search response based on the context it is used

func (*LogService20210330SearchResponse) MarshalBinary

func (m *LogService20210330SearchResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330SearchResponse) UnmarshalBinary

func (m *LogService20210330SearchResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330SearchResponse) Validate

Validate validates this log service 20210330 search response

type LogService20210330ServiceLogEvent

type LogService20210330ServiceLogEvent struct {

	// event_type represents the type log entry this event represents.
	EventType *LogService20210330EventType `json:"event_type,omitempty"`

	// insert_id is an optional, unique, identifier for the log event.
	// Clients can assign this field a value or it will be assigned as part of
	// processing by the log service.
	InsertID string `json:"insert_id,omitempty"`

	// json payload
	JSONPayload interface{} `json:"json_payload,omitempty"`

	// log_name is the service/resource name the log belongs to.
	LogName string `json:"log_name,omitempty"`

	// metadata is an extra information service teams want to add to a customer payload
	Metadata interface{} `json:"metadata,omitempty"`

	// text payload
	TextPayload string `json:"text_payload,omitempty"`
}

LogService20210330ServiceLogEvent log service 20210330 service log event

swagger:model log_service_20210330ServiceLogEvent

func (*LogService20210330ServiceLogEvent) ContextValidate

func (m *LogService20210330ServiceLogEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 service log event based on the context it is used

func (*LogService20210330ServiceLogEvent) MarshalBinary

func (m *LogService20210330ServiceLogEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330ServiceLogEvent) UnmarshalBinary

func (m *LogService20210330ServiceLogEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330ServiceLogEvent) Validate

Validate validates this log service 20210330 service log event

type LogService20210330ServicePrincipalDelegationInfo

type LogService20210330ServicePrincipalDelegationInfo struct {

	// resource_id is the id of the principal or workload identity provider that
	// assumed the service principal.
	ResourceID string `json:"resource_id,omitempty"`

	// resource_name is the resource_name of the principal or workload identity provider that
	// assumed the service principal.
	ResourceName string `json:"resource_name,omitempty"`
}

LogService20210330ServicePrincipalDelegationInfo ServicePrincipalDelegationInfo captures the identity or workload identity provider that was used to assume a service principal.

swagger:model log_service_20210330ServicePrincipalDelegationInfo

func (*LogService20210330ServicePrincipalDelegationInfo) ContextValidate

ContextValidate validates this log service 20210330 service principal delegation info based on context it is used

func (*LogService20210330ServicePrincipalDelegationInfo) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330ServicePrincipalDelegationInfo) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330ServicePrincipalDelegationInfo) Validate

Validate validates this log service 20210330 service principal delegation info

type LogService20210330SplunkCloudProvider

type LogService20210330SplunkCloudProvider struct {

	// hec_endpoint represents the splunk endpoint to which to stream logs.
	HecEndpoint string `json:"hec_endpoint,omitempty"`

	// token represents the access token used when streaming to the splunk endpoint.
	Token string `json:"token,omitempty"`
}

LogService20210330SplunkCloudProvider SplunkCloudProvider represents the necessary information to configure a splunk cloud destination.

swagger:model log_service_20210330SplunkCloudProvider

func (*LogService20210330SplunkCloudProvider) ContextValidate

func (m *LogService20210330SplunkCloudProvider) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 splunk cloud provider based on context it is used

func (*LogService20210330SplunkCloudProvider) MarshalBinary

func (m *LogService20210330SplunkCloudProvider) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330SplunkCloudProvider) UnmarshalBinary

func (m *LogService20210330SplunkCloudProvider) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330SplunkCloudProvider) Validate

Validate validates this log service 20210330 splunk cloud provider

type LogService20210330Status

type LogService20210330Status string

LogService20210330Status Status is the status of an ArchiveRequest

swagger:model log_service_20210330Status

const (

	// LogService20210330StatusSTATUSUNSET captures enum value "STATUS_UNSET"
	LogService20210330StatusSTATUSUNSET LogService20210330Status = "STATUS_UNSET"

	// LogService20210330StatusSTATUSPROCESSING captures enum value "STATUS_PROCESSING"
	LogService20210330StatusSTATUSPROCESSING LogService20210330Status = "STATUS_PROCESSING"

	// LogService20210330StatusSTATUSCOMPLETED captures enum value "STATUS_COMPLETED"
	LogService20210330StatusSTATUSCOMPLETED LogService20210330Status = "STATUS_COMPLETED"

	// LogService20210330StatusSTATUSFAILED captures enum value "STATUS_FAILED"
	LogService20210330StatusSTATUSFAILED LogService20210330Status = "STATUS_FAILED"
)

func (LogService20210330Status) ContextValidate

func (m LogService20210330Status) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this log service 20210330 status based on context it is used

func (LogService20210330Status) Pointer

Pointer returns a pointer to a freshly-allocated LogService20210330Status.

func (LogService20210330Status) Validate

func (m LogService20210330Status) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 status

type LogService20210330StoreRequest

type LogService20210330StoreRequest struct {

	// entries is the batch of log entries to store.
	Entries []*LogService20210330LogEntry `json:"entries"`

	// stream identifies the log stream this request's batch of log entries is a
	// part of.
	Stream *LogService20210330LogStream `json:"stream,omitempty"`
}

LogService20210330StoreRequest log service 20210330 store request

swagger:model log_service_20210330StoreRequest

func (*LogService20210330StoreRequest) ContextValidate

func (m *LogService20210330StoreRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 store request based on the context it is used

func (*LogService20210330StoreRequest) MarshalBinary

func (m *LogService20210330StoreRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330StoreRequest) UnmarshalBinary

func (m *LogService20210330StoreRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330StoreRequest) Validate

func (m *LogService20210330StoreRequest) Validate(formats strfmt.Registry) error

Validate validates this log service 20210330 store request

type LogService20210330StreamsResponse

type LogService20210330StreamsResponse struct {

	// entries is the list of log entries matching the query.
	Entries []*LogService20210330LogEntry `json:"entries"`
}

LogService20210330StreamsResponse log service 20210330 streams response

swagger:model log_service_20210330StreamsResponse

func (*LogService20210330StreamsResponse) ContextValidate

func (m *LogService20210330StreamsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this log service 20210330 streams response based on the context it is used

func (*LogService20210330StreamsResponse) MarshalBinary

func (m *LogService20210330StreamsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LogService20210330StreamsResponse) UnmarshalBinary

func (m *LogService20210330StreamsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LogService20210330StreamsResponse) Validate

Validate validates this log service 20210330 streams response

type LogService20210330TestStreamingDestinationRequest

type LogService20210330TestStreamingDestinationRequest struct {

	// cloudwatchlogs_provider represents a cloudwatch provider.
	CloudwatchlogsProvider *LogService20210330CloudwatchLogsProvider `json:"cloudwatchlogs_provider,omitempty"`

	// datadog_provider represents a datadog provider.
	DatadogProvider *LogService20210330DatadogProvider `json:"datadog_provider,omitempty"`

	// existing_destination_id is the original destination id
	// this should be set only if we need to test config with redacted fields
	ExistingDestinationID string `json:"existing_destination_id,omitempty"`

	// location is the location (orgID - projectID) the streaming destination will belong to.
	Location *CloudlocationLocation `json:"location,omitempty"`

	// mask specifies which fields to use from provider to override fields in existing destination
	Mask *ProtobufFieldMask `json:"mask,omitempty"`
}

LogService20210330TestStreamingDestinationRequest TestStreamingDestinationRequest represents a request to test a streaming destination config record.

swagger:model log_service_20210330TestStreamingDestinationRequest

func (*LogService20210330TestStreamingDestinationRequest) ContextValidate

ContextValidate validate this log service 20210330 test streaming destination request based on the context it is used

func (*LogService20210330TestStreamingDestinationRequest) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330TestStreamingDestinationRequest) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330TestStreamingDestinationRequest) Validate

Validate validates this log service 20210330 test streaming destination request

type LogService20210330TestStreamingDestinationResponse

type LogService20210330TestStreamingDestinationResponse struct {

	// error_message is an optional message that includes additional details about the error
	// it would be used if the error message is meaningful or actionable to the customer
	// in some cases (e.g. internal errors) we will not include any messages
	ErrorMessage string `json:"error_message,omitempty"`

	// error_type is a high level category of error, so the UI can link to some kind of relevant recommendation
	// possible types
	// internal       -> something internal failed (e.g. lambda outage, a bug ...etc)
	// access         -> access related issues (e.g. api key not allowed to write logs, iam role cannot be assumed)
	// invalid_config -> destination config are invalid, or not available (e.g. invalid iam role, or iam role does not exist)
	ErrorType string `json:"error_type,omitempty"`

	// request_id is a unique id that can be used to refer to this specific test operation
	RequestID string `json:"request_id,omitempty"`

	// status is the overall status of the test destination operation
	// success means that the test passed successfully
	// failed means that the test failed for some reason
	Status string `json:"status,omitempty"`

	// test_payload is the log payload we sent to the customer destination
	// this would only be set if the status is "success"
	TestPayload string `json:"test_payload,omitempty"`
}

LogService20210330TestStreamingDestinationResponse TestStreamingDestinationResponse represents a a response from test a streaming destination

swagger:model log_service_20210330TestStreamingDestinationResponse

func (*LogService20210330TestStreamingDestinationResponse) ContextValidate

ContextValidate validates this log service 20210330 test streaming destination response based on context it is used

func (*LogService20210330TestStreamingDestinationResponse) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330TestStreamingDestinationResponse) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330TestStreamingDestinationResponse) Validate

Validate validates this log service 20210330 test streaming destination response

type LogService20210330UpdateStreamingDestinationRequest

type LogService20210330UpdateStreamingDestinationRequest struct {

	// destination represents the destination record.
	Destination *LogService20210330Destination `json:"destination,omitempty"`

	// mask represnts the requested fields to be updated.
	Mask *ProtobufFieldMask `json:"mask,omitempty"`

	// source_channel denotes where the update request was made from. For example terraform or the hcp ui.
	SourceChannel string `json:"source_channel,omitempty"`
}

LogService20210330UpdateStreamingDestinationRequest UpdateStreamingDestinationRequest represents a request to update a destination record name or confiuration.

swagger:model log_service_20210330UpdateStreamingDestinationRequest

func (*LogService20210330UpdateStreamingDestinationRequest) ContextValidate

ContextValidate validate this log service 20210330 update streaming destination request based on the context it is used

func (*LogService20210330UpdateStreamingDestinationRequest) MarshalBinary

MarshalBinary interface implementation

func (*LogService20210330UpdateStreamingDestinationRequest) UnmarshalBinary

UnmarshalBinary interface implementation

func (*LogService20210330UpdateStreamingDestinationRequest) Validate

Validate validates this log service 20210330 update streaming destination request

type ProtobufAny

type ProtobufAny 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.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	TypeURL string `json:"type_url,omitempty"`

	// Must be a valid serialized protocol buffer of the above specified type.
	// Format: byte
	Value strfmt.Base64 `json:"value,omitempty"`
}

ProtobufAny `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);
}

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"
}

swagger:model protobufAny

func (*ProtobufAny) ContextValidate

func (m *ProtobufAny) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf any based on context it is used

func (*ProtobufAny) MarshalBinary

func (m *ProtobufAny) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProtobufAny) UnmarshalBinary

func (m *ProtobufAny) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProtobufAny) Validate

func (m *ProtobufAny) Validate(formats strfmt.Registry) error

Validate validates this protobuf any

type ProtobufFieldMask

type ProtobufFieldMask struct {

	// The set of field mask paths.
	Paths []string `json:"paths"`
}

ProtobufFieldMask `FieldMask` represents a set of symbolic field paths, for example:

paths: "f.a"

paths: "f.b.d"

Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`.

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below).

Field Masks in Projections

When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows:

f {
  a : 22
  b {
    d : 1
    x : 2
  }
  y : 13
}
z: 8

The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output):

f {
  a : 22
  b {
    d : 1
  }
}

A repeated field is not allowed except at the last position of a paths string.

If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified).

Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs.

Field Masks in Update Operations

A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask.

If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string.

If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource.

For example, given the target message:

f {
  b {
    d: 1
    x: 2
  }
  c: [1]
}

And an update message:

f {
  b {
    d: 10
  }
  c: [2]
}

then if the field mask is:

paths: ["f.b", "f.c"]

then the result will be:

f {
  b {
    d: 10
    x: 2
  }
  c: [1, 2]
}

An implementation may provide options to override this default behavior for repeated and message fields.

In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below.

If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not.

As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API.

## Considerations for HTTP REST

The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates).

JSON Encoding of Field Masks

In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions.

As an example, consider the following message declarations:

message Profile {
  User user = 1;
  Photo photo = 2;
}
message User {
  string display_name = 1;
  string address = 2;
}

In proto a field mask for `Profile` may look as such:

mask {
  paths: "user.display_name"
  paths: "photo"
}

In JSON, the same mask is represented as below:

{
  mask: "user.displayName,photo"
}

Field Masks and Oneof Fields

Field masks treat fields in oneofs just as regular fields. Consider the following message:

message SampleMessage {
  oneof test_oneof {
    string name = 4;
    SubMessage sub_message = 9;
  }
}

The field mask can be:

mask {
  paths: "name"
}

Or:

mask {
  paths: "sub_message"
}

Note that oneof type names ("test_oneof" in this case) cannot be used in paths.

## Field Mask Verification

The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is unmappable.

swagger:model protobufFieldMask

func (*ProtobufFieldMask) ContextValidate

func (m *ProtobufFieldMask) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf field mask based on context it is used

func (*ProtobufFieldMask) MarshalBinary

func (m *ProtobufFieldMask) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProtobufFieldMask) UnmarshalBinary

func (m *ProtobufFieldMask) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProtobufFieldMask) Validate

func (m *ProtobufFieldMask) Validate(formats strfmt.Registry) error

Validate validates this protobuf field mask

type ProtobufNullValue

type ProtobufNullValue string

ProtobufNullValue `NullValue` is a singleton enumeration to represent the null value for the `Value` type union.

The JSON representation for `NullValue` is JSON `null`.

- NULL_VALUE: Null value.

swagger:model protobufNullValue

const (

	// ProtobufNullValueNULLVALUE captures enum value "NULL_VALUE"
	ProtobufNullValueNULLVALUE ProtobufNullValue = "NULL_VALUE"
)

func NewProtobufNullValue

func NewProtobufNullValue(value ProtobufNullValue) *ProtobufNullValue

func (ProtobufNullValue) ContextValidate

func (m ProtobufNullValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf null value based on context it is used

func (ProtobufNullValue) Pointer

func (m ProtobufNullValue) Pointer() *ProtobufNullValue

Pointer returns a pointer to a freshly-allocated ProtobufNullValue.

func (ProtobufNullValue) Validate

func (m ProtobufNullValue) Validate(formats strfmt.Registry) error

Validate validates this protobuf null value

type RuntimeError

type RuntimeError struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*ProtobufAny `json:"details"`

	// error
	Error string `json:"error,omitempty"`

	// message
	Message string `json:"message,omitempty"`
}

RuntimeError runtime error

swagger:model runtimeError

func (*RuntimeError) ContextValidate

func (m *RuntimeError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this runtime error based on the context it is used

func (*RuntimeError) MarshalBinary

func (m *RuntimeError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuntimeError) UnmarshalBinary

func (m *RuntimeError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuntimeError) Validate

func (m *RuntimeError) Validate(formats strfmt.Registry) error

Validate validates this runtime error

type UserPrincipalIdentityType

type UserPrincipalIdentityType string

UserPrincipalIdentityType IdentityType contains the identity types for users.

  • UNSET: UNSET is the default value, should not be used.
  • SOCIAL_GITHUB: SOCIAL_GITHUB is the GitHub Social login provider.
  • EMAIL_PASSWORD: EMAIL_PASSWORD is the auth0 email/password database provider.
  • SAMLP: SAMLP is the auth0 SAML provider.
  • HASHICORP_SSO: HASHICORP_SSO is the HashiCorp SSO provider.

swagger:model UserPrincipalIdentityType

const (

	// UserPrincipalIdentityTypeUNSET captures enum value "UNSET"
	UserPrincipalIdentityTypeUNSET UserPrincipalIdentityType = "UNSET"

	// UserPrincipalIdentityTypeSOCIALGITHUB captures enum value "SOCIAL_GITHUB"
	UserPrincipalIdentityTypeSOCIALGITHUB UserPrincipalIdentityType = "SOCIAL_GITHUB"

	// UserPrincipalIdentityTypeEMAILPASSWORD captures enum value "EMAIL_PASSWORD"
	UserPrincipalIdentityTypeEMAILPASSWORD UserPrincipalIdentityType = "EMAIL_PASSWORD"

	// UserPrincipalIdentityTypeSAMLP captures enum value "SAMLP"
	UserPrincipalIdentityTypeSAMLP UserPrincipalIdentityType = "SAMLP"

	// UserPrincipalIdentityTypeHASHICORPSSO captures enum value "HASHICORP_SSO"
	UserPrincipalIdentityTypeHASHICORPSSO UserPrincipalIdentityType = "HASHICORP_SSO"
)

func (UserPrincipalIdentityType) ContextValidate

func (m UserPrincipalIdentityType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user principal identity type based on context it is used

func (UserPrincipalIdentityType) Pointer

Pointer returns a pointer to a freshly-allocated UserPrincipalIdentityType.

func (UserPrincipalIdentityType) Validate

func (m UserPrincipalIdentityType) Validate(formats strfmt.Registry) error

Validate validates this user principal identity type

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL