Container Analysis API v1beta1 - Package cloud.google.com/go/containeranalysis/apiv1beta1/containeranalysispb (v0.19.0)

0.19.0 (latest) 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.4 0.12.2 0.11.8 0.10.1 0.9.2 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.0 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

ContainerAnalysisV1Beta1_SetIamPolicy_FullMethodName, ContainerAnalysisV1Beta1_GetIamPolicy_FullMethodName, ContainerAnalysisV1Beta1_TestIamPermissions_FullMethodName, ContainerAnalysisV1Beta1_GeneratePackagesSummary_FullMethodName, ContainerAnalysisV1Beta1_ExportSBOM_FullMethodName

const (
	ContainerAnalysisV1Beta1_SetIamPolicy_FullMethodName            = "/google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1/SetIamPolicy"
	ContainerAnalysisV1Beta1_GetIamPolicy_FullMethodName            = "/google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1/GetIamPolicy"
	ContainerAnalysisV1Beta1_TestIamPermissions_FullMethodName      = "/google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1/TestIamPermissions"
	ContainerAnalysisV1Beta1_GeneratePackagesSummary_FullMethodName = "/google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1/GeneratePackagesSummary"
	ContainerAnalysisV1Beta1_ExportSBOM_FullMethodName              = "/google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1/ExportSBOM"
)

Variables

ContainerAnalysisV1Beta1_ServiceDesc

var ContainerAnalysisV1Beta1_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1",
	HandlerType: (*ContainerAnalysisV1Beta1Server)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetIamPolicy",
			Handler:    _ContainerAnalysisV1Beta1_SetIamPolicy_Handler,
		},
		{
			MethodName: "GetIamPolicy",
			Handler:    _ContainerAnalysisV1Beta1_GetIamPolicy_Handler,
		},
		{
			MethodName: "TestIamPermissions",
			Handler:    _ContainerAnalysisV1Beta1_TestIamPermissions_Handler,
		},
		{
			MethodName: "GeneratePackagesSummary",
			Handler:    _ContainerAnalysisV1Beta1_GeneratePackagesSummary_Handler,
		},
		{
			MethodName: "ExportSBOM",
			Handler:    _ContainerAnalysisV1Beta1_ExportSBOM_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/devtools/containeranalysis/v1beta1/containeranalysis.proto",
}

ContainerAnalysisV1Beta1_ServiceDesc is the grpc.ServiceDesc for ContainerAnalysisV1Beta1 service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_devtools_containeranalysis_v1beta1_containeranalysis_proto

var File_google_devtools_containeranalysis_v1beta1_containeranalysis_proto protoreflect.FileDescriptor

Functions

func RegisterContainerAnalysisV1Beta1Server

func RegisterContainerAnalysisV1Beta1Server(s grpc.ServiceRegistrar, srv ContainerAnalysisV1Beta1Server)

ContainerAnalysisV1Beta1Client

type ContainerAnalysisV1Beta1Client interface {
	// Sets the access control policy on the specified note or occurrence.
	// Requires `containeranalysis.notes.setIamPolicy` or
	// `containeranalysis.occurrences.setIamPolicy` permission if the resource is
	// a note or an occurrence, respectively.
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Gets the access control policy for a note or an occurrence resource.
	// Requires `containeranalysis.notes.setIamPolicy` or
	// `containeranalysis.occurrences.setIamPolicy` permission if the resource is
	// a note or occurrence, respectively.
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Returns the permissions that a caller has on the specified note or
	// occurrence. Requires list permission on the project (for example,
	// `containeranalysis.notes.list`).
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
	// Gets a summary of the packages within a given resource.
	GeneratePackagesSummary(ctx context.Context, in *GeneratePackagesSummaryRequest, opts ...grpc.CallOption) (*PackagesSummaryResponse, error)
	// Generates an SBOM and other dependency information for the given resource.
	ExportSBOM(ctx context.Context, in *ExportSBOMRequest, opts ...grpc.CallOption) (*ExportSBOMResponse, error)
}

ContainerAnalysisV1Beta1Client is the client API for ContainerAnalysisV1Beta1 service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewContainerAnalysisV1Beta1Client

func NewContainerAnalysisV1Beta1Client(cc grpc.ClientConnInterface) ContainerAnalysisV1Beta1Client

ContainerAnalysisV1Beta1Server

type ContainerAnalysisV1Beta1Server interface {
	// Sets the access control policy on the specified note or occurrence.
	// Requires `containeranalysis.notes.setIamPolicy` or
	// `containeranalysis.occurrences.setIamPolicy` permission if the resource is
	// a note or an occurrence, respectively.
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Gets the access control policy for a note or an occurrence resource.
	// Requires `containeranalysis.notes.setIamPolicy` or
	// `containeranalysis.occurrences.setIamPolicy` permission if the resource is
	// a note or occurrence, respectively.
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Returns the permissions that a caller has on the specified note or
	// occurrence. Requires list permission on the project (for example,
	// `containeranalysis.notes.list`).
	//
	// The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for
	// notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for
	// occurrences.
	TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
	// Gets a summary of the packages within a given resource.
	GeneratePackagesSummary(context.Context, *GeneratePackagesSummaryRequest) (*PackagesSummaryResponse, error)
	// Generates an SBOM and other dependency information for the given resource.
	ExportSBOM(context.Context, *ExportSBOMRequest) (*ExportSBOMResponse, error)
}

ContainerAnalysisV1Beta1Server is the server API for ContainerAnalysisV1Beta1 service. All implementations should embed UnimplementedContainerAnalysisV1Beta1Server for forward compatibility

ExportSBOMRequest

type ExportSBOMRequest struct {

	// Required. The name of the resource in the form of
	// `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request to a call of ExportSBOM

func (*ExportSBOMRequest) Descriptor

func (*ExportSBOMRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportSBOMRequest.ProtoReflect.Descriptor instead.

func (*ExportSBOMRequest) GetName

func (x *ExportSBOMRequest) GetName() string

func (*ExportSBOMRequest) ProtoMessage

func (*ExportSBOMRequest) ProtoMessage()

func (*ExportSBOMRequest) ProtoReflect

func (x *ExportSBOMRequest) ProtoReflect() protoreflect.Message

func (*ExportSBOMRequest) Reset

func (x *ExportSBOMRequest) Reset()

func (*ExportSBOMRequest) String

func (x *ExportSBOMRequest) String() string

ExportSBOMResponse

type ExportSBOMResponse struct {

	// The name of the discovery occurrence in the form
	// "projects/{project_id}/occurrences/{OCCURRENCE_ID}
	// It can be used to track the progression of the SBOM export.
	DiscoveryOccurrenceId string `protobuf:"bytes,1,opt,name=discovery_occurrence_id,json=discoveryOccurrenceId,proto3" json:"discovery_occurrence_id,omitempty"`
	// contains filtered or unexported fields
}

The response from a call to ExportSBOM

func (*ExportSBOMResponse) Descriptor

func (*ExportSBOMResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportSBOMResponse.ProtoReflect.Descriptor instead.

func (*ExportSBOMResponse) GetDiscoveryOccurrenceId

func (x *ExportSBOMResponse) GetDiscoveryOccurrenceId() string

func (*ExportSBOMResponse) ProtoMessage

func (*ExportSBOMResponse) ProtoMessage()

func (*ExportSBOMResponse) ProtoReflect

func (x *ExportSBOMResponse) ProtoReflect() protoreflect.Message

func (*ExportSBOMResponse) Reset

func (x *ExportSBOMResponse) Reset()

func (*ExportSBOMResponse) String

func (x *ExportSBOMResponse) String() string

GeneratePackagesSummaryRequest

type GeneratePackagesSummaryRequest struct {

	// Required. The name of the resource to get a packages summary for in the
	// form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

GeneratePackagesSummaryRequest is the request body for the GeneratePackagesSummary API method. It just takes a single name argument, referring to the resource.

func (*GeneratePackagesSummaryRequest) Descriptor

func (*GeneratePackagesSummaryRequest) Descriptor() ([]byte, []int)

Deprecated: Use GeneratePackagesSummaryRequest.ProtoReflect.Descriptor instead.

func (*GeneratePackagesSummaryRequest) GetName

func (x *GeneratePackagesSummaryRequest) GetName() string

func (*GeneratePackagesSummaryRequest) ProtoMessage

func (*GeneratePackagesSummaryRequest) ProtoMessage()

func (*GeneratePackagesSummaryRequest) ProtoReflect

func (x *GeneratePackagesSummaryRequest) ProtoReflect() protoreflect.Message

func (*GeneratePackagesSummaryRequest) Reset

func (x *GeneratePackagesSummaryRequest) Reset()

func (*GeneratePackagesSummaryRequest) String

func (x *GeneratePackagesSummaryRequest) String() string

PackagesSummaryResponse

type PackagesSummaryResponse struct {

	// The unique URL of the image or the container for which this summary
	// applies.
	ResourceUrl string `protobuf:"bytes,1,opt,name=resource_url,json=resourceUrl,proto3" json:"resource_url,omitempty"`
	// A listing by license name of each of the licenses and their counts.
	LicensesSummary []*PackagesSummaryResponse_LicensesSummary `protobuf:"bytes,2,rep,name=licenses_summary,json=licensesSummary,proto3" json:"licenses_summary,omitempty"`
	// contains filtered or unexported fields
}

A summary of the packages found within the given resource.

func (*PackagesSummaryResponse) Descriptor

func (*PackagesSummaryResponse) Descriptor() ([]byte, []int)

Deprecated: Use PackagesSummaryResponse.ProtoReflect.Descriptor instead.

func (*PackagesSummaryResponse) GetLicensesSummary

func (x *PackagesSummaryResponse) GetLicensesSummary() []*PackagesSummaryResponse_LicensesSummary

func (*PackagesSummaryResponse) GetResourceUrl

func (x *PackagesSummaryResponse) GetResourceUrl() string

func (*PackagesSummaryResponse) ProtoMessage

func (*PackagesSummaryResponse) ProtoMessage()

func (*PackagesSummaryResponse) ProtoReflect

func (x *PackagesSummaryResponse) ProtoReflect() protoreflect.Message

func (*PackagesSummaryResponse) Reset

func (x *PackagesSummaryResponse) Reset()

func (*PackagesSummaryResponse) String

func (x *PackagesSummaryResponse) String() string

PackagesSummaryResponse_LicensesSummary

type PackagesSummaryResponse_LicensesSummary struct {

	// The license of the package. Note that the format of this value is not
	// guaranteed. It may be nil, an empty string, a boolean value (A | B), a
	// differently formed boolean value (A OR B), etc...
	License string `protobuf:"bytes,1,opt,name=license,proto3" json:"license,omitempty"`
	// The number of fixable vulnerabilities associated with this resource.
	Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

Per license count

func (*PackagesSummaryResponse_LicensesSummary) Descriptor

func (*PackagesSummaryResponse_LicensesSummary) Descriptor() ([]byte, []int)

Deprecated: Use PackagesSummaryResponse_LicensesSummary.ProtoReflect.Descriptor instead.

func (*PackagesSummaryResponse_LicensesSummary) GetCount

func (x *PackagesSummaryResponse_LicensesSummary) GetCount() int64

func (*PackagesSummaryResponse_LicensesSummary) GetLicense

func (x *PackagesSummaryResponse_LicensesSummary) GetLicense() string

func (*PackagesSummaryResponse_LicensesSummary) ProtoMessage

func (*PackagesSummaryResponse_LicensesSummary) ProtoMessage()

func (*PackagesSummaryResponse_LicensesSummary) ProtoReflect

func (x *PackagesSummaryResponse_LicensesSummary) ProtoReflect() protoreflect.Message

func (*PackagesSummaryResponse_LicensesSummary) Reset

func (x *PackagesSummaryResponse_LicensesSummary) Reset()

func (*PackagesSummaryResponse_LicensesSummary) String

func (x *PackagesSummaryResponse_LicensesSummary) String() string

UnimplementedContainerAnalysisV1Beta1Server

type UnimplementedContainerAnalysisV1Beta1Server struct {
}

UnimplementedContainerAnalysisV1Beta1Server should be embedded to have forward compatible implementations.

func (UnimplementedContainerAnalysisV1Beta1Server) ExportSBOM

func (UnimplementedContainerAnalysisV1Beta1Server) ExportSBOM(context.Context, *ExportSBOMRequest) (*ExportSBOMResponse, error)

func (UnimplementedContainerAnalysisV1Beta1Server) GeneratePackagesSummary

func (UnimplementedContainerAnalysisV1Beta1Server) GeneratePackagesSummary(context.Context, *GeneratePackagesSummaryRequest) (*PackagesSummaryResponse, error)

func (UnimplementedContainerAnalysisV1Beta1Server) GetIamPolicy

func (UnimplementedContainerAnalysisV1Beta1Server) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)

func (UnimplementedContainerAnalysisV1Beta1Server) SetIamPolicy

func (UnimplementedContainerAnalysisV1Beta1Server) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

func (UnimplementedContainerAnalysisV1Beta1Server) TestIamPermissions

func (UnimplementedContainerAnalysisV1Beta1Server) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

UnsafeContainerAnalysisV1Beta1Server

type UnsafeContainerAnalysisV1Beta1Server interface {
	// contains filtered or unexported methods
}

UnsafeContainerAnalysisV1Beta1Server may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ContainerAnalysisV1Beta1Server will result in compilation errors.