Documentation
¶
Index ¶
- type GenericArtifact
- type GenericArtifactLifecycleStateEnum
- type GenericArtifactsContentClient
- func NewGenericArtifactsContentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenericArtifactsContentClient, err error)
- func NewGenericArtifactsContentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenericArtifactsContentClient, err error)
- func (client *GenericArtifactsContentClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client GenericArtifactsContentClient) GetGenericArtifactContent(ctx context.Context, request GetGenericArtifactContentRequest) (response GetGenericArtifactContentResponse, err error)
- func (client GenericArtifactsContentClient) GetGenericArtifactContentByPath(ctx context.Context, request GetGenericArtifactContentByPathRequest) (response GetGenericArtifactContentByPathResponse, err error)
- func (client GenericArtifactsContentClient) PutGenericArtifactContentByPath(ctx context.Context, request PutGenericArtifactContentByPathRequest) (response PutGenericArtifactContentByPathResponse, err error)
- func (client *GenericArtifactsContentClient) SetRegion(region string)
- type GetGenericArtifactContentByPathRequest
- func (request GetGenericArtifactContentByPathRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request GetGenericArtifactContentByPathRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request GetGenericArtifactContentByPathRequest) RetryPolicy() *common.RetryPolicy
- func (request GetGenericArtifactContentByPathRequest) String() string
- type GetGenericArtifactContentByPathResponse
- type GetGenericArtifactContentRequest
- func (request GetGenericArtifactContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request GetGenericArtifactContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request GetGenericArtifactContentRequest) RetryPolicy() *common.RetryPolicy
- func (request GetGenericArtifactContentRequest) String() string
- type GetGenericArtifactContentResponse
- type PutGenericArtifactContentByPathRequest
- func (request PutGenericArtifactContentByPathRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request PutGenericArtifactContentByPathRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request PutGenericArtifactContentByPathRequest) RetryPolicy() *common.RetryPolicy
- func (request PutGenericArtifactContentByPathRequest) String() string
- type PutGenericArtifactContentByPathResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GenericArtifact ¶
type GenericArtifact struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.
// Example: `ocid1.genericartifact.oc1..exampleuniqueID`
Id *string `mandatory:"true" json:"id"`
// The artifact name with the format of `<artifact-path>:<artifact-version>`. The artifact name is truncated to a maximum length of 255.
// Example: `project01/my-web-app/artifact-abc:1.0.0`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the repository.
RepositoryId *string `mandatory:"true" json:"repositoryId"`
// A user-defined path to describe the location of an artifact. Slashes do not create a directory structure, but you can use slashes to organize the repository. An artifact path does not include an artifact version.
// Example: `project01/my-web-app/artifact-abc`
ArtifactPath *string `mandatory:"true" json:"artifactPath"`
// A user-defined string to describe the artifact version.
// Example: `1.1.0` or `1.2-beta-2`
Version *string `mandatory:"true" json:"version"`
// The SHA256 digest for the artifact. When you upload an artifact to the repository, a SHA256 digest is calculated and added to the artifact properties.
Sha256 *string `mandatory:"true" json:"sha256"`
// The size of the artifact in bytes.
SizeInBytes *int64 `mandatory:"true" json:"sizeInBytes"`
// The current state of the artifact.
LifecycleState GenericArtifactLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// An RFC 3339 timestamp indicating when the repository was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
GenericArtifact The metadata of the artifact.
func (GenericArtifact) String ¶
func (m GenericArtifact) String() string
type GenericArtifactLifecycleStateEnum ¶
type GenericArtifactLifecycleStateEnum string
GenericArtifactLifecycleStateEnum Enum with underlying type: string
const ( GenericArtifactLifecycleStateAvailable GenericArtifactLifecycleStateEnum = "AVAILABLE" GenericArtifactLifecycleStateDeleting GenericArtifactLifecycleStateEnum = "DELETING" GenericArtifactLifecycleStateDeleted GenericArtifactLifecycleStateEnum = "DELETED" )
Set of constants representing the allowable values for GenericArtifactLifecycleStateEnum
func GetGenericArtifactLifecycleStateEnumValues ¶
func GetGenericArtifactLifecycleStateEnumValues() []GenericArtifactLifecycleStateEnum
GetGenericArtifactLifecycleStateEnumValues Enumerates the set of values for GenericArtifactLifecycleStateEnum
type GenericArtifactsContentClient ¶
type GenericArtifactsContentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
GenericArtifactsContentClient a client for GenericArtifactsContent
func NewGenericArtifactsContentClientWithConfigurationProvider ¶
func NewGenericArtifactsContentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenericArtifactsContentClient, err error)
NewGenericArtifactsContentClientWithConfigurationProvider Creates a new default GenericArtifactsContent client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenericArtifactsContentClientWithOboToken ¶
func NewGenericArtifactsContentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenericArtifactsContentClient, err error)
NewGenericArtifactsContentClientWithOboToken Creates a new default GenericArtifactsContent client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (*GenericArtifactsContentClient) ConfigurationProvider ¶
func (client *GenericArtifactsContentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (GenericArtifactsContentClient) GetGenericArtifactContent ¶
func (client GenericArtifactsContentClient) GetGenericArtifactContent(ctx context.Context, request GetGenericArtifactContentRequest) (response GetGenericArtifactContentResponse, err error)
GetGenericArtifactContent Gets the specified artifact's content.
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/GetGenericArtifactContent.go.html to see an example of how to use GetGenericArtifactContent API.
func (GenericArtifactsContentClient) GetGenericArtifactContentByPath ¶
func (client GenericArtifactsContentClient) GetGenericArtifactContentByPath(ctx context.Context, request GetGenericArtifactContentByPathRequest) (response GetGenericArtifactContentByPathResponse, err error)
GetGenericArtifactContentByPath Gets the content of an artifact with a specified `artifactPath` and `version`.
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/GetGenericArtifactContentByPath.go.html to see an example of how to use GetGenericArtifactContentByPath API.
func (GenericArtifactsContentClient) PutGenericArtifactContentByPath ¶
func (client GenericArtifactsContentClient) PutGenericArtifactContentByPath(ctx context.Context, request PutGenericArtifactContentByPathRequest) (response PutGenericArtifactContentByPathResponse, err error)
PutGenericArtifactContentByPath Uploads an artifact. Provide `artifactPath`, `version` and content. Avoid entering confidential information when you define the path and version.
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/PutGenericArtifactContentByPath.go.html to see an example of how to use PutGenericArtifactContentByPath API.
func (*GenericArtifactsContentClient) SetRegion ¶
func (client *GenericArtifactsContentClient) SetRegion(region string)
SetRegion overrides the region of this client.
type GetGenericArtifactContentByPathRequest ¶
type GetGenericArtifactContentByPathRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.
// Example: `ocid1.repository.oc1..exampleuniqueID`
RepositoryId *string `mandatory:"true" contributesTo:"path" name:"repositoryId"`
// A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.
// Example: `project01/my-web-app/artifact-abc`
ArtifactPath *string `mandatory:"true" contributesTo:"path" name:"artifactPath"`
// A user-defined string to describe the artifact version.
// Example: `1.1.2` or `1.2-beta-2`
Version *string `mandatory:"true" contributesTo:"path" name:"version"`
// Unique Oracle-assigned request ID (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm)
// Example: `bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx`
// If you contact Oracle about a request, provide this request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
GetGenericArtifactContentByPathRequest wrapper for the GetGenericArtifactContentByPath operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/GetGenericArtifactContentByPath.go.html to see an example of how to use GetGenericArtifactContentByPathRequest.
func (GetGenericArtifactContentByPathRequest) BinaryRequestBody ¶
func (request GetGenericArtifactContentByPathRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (GetGenericArtifactContentByPathRequest) HTTPRequest ¶
func (request GetGenericArtifactContentByPathRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetGenericArtifactContentByPathRequest) RetryPolicy ¶
func (request GetGenericArtifactContentByPathRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetGenericArtifactContentByPathRequest) String ¶
func (request GetGenericArtifactContentByPathRequest) String() string
type GetGenericArtifactContentByPathResponse ¶
type GetGenericArtifactContentByPathResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
GetGenericArtifactContentByPathResponse wrapper for the GetGenericArtifactContentByPath operation
func (GetGenericArtifactContentByPathResponse) HTTPResponse ¶
func (response GetGenericArtifactContentByPathResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetGenericArtifactContentByPathResponse) String ¶
func (response GetGenericArtifactContentByPathResponse) String() string
type GetGenericArtifactContentRequest ¶
type GetGenericArtifactContentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.
// Example: `ocid1.genericartifact.oc1..exampleuniqueID`
ArtifactId *string `mandatory:"true" contributesTo:"path" name:"artifactId"`
// Unique Oracle-assigned request ID (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm)
// Example: `bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx`
// If you contact Oracle about a request, provide this request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
GetGenericArtifactContentRequest wrapper for the GetGenericArtifactContent operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/GetGenericArtifactContent.go.html to see an example of how to use GetGenericArtifactContentRequest.
func (GetGenericArtifactContentRequest) BinaryRequestBody ¶
func (request GetGenericArtifactContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (GetGenericArtifactContentRequest) HTTPRequest ¶
func (request GetGenericArtifactContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetGenericArtifactContentRequest) RetryPolicy ¶
func (request GetGenericArtifactContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetGenericArtifactContentRequest) String ¶
func (request GetGenericArtifactContentRequest) String() string
type GetGenericArtifactContentResponse ¶
type GetGenericArtifactContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
GetGenericArtifactContentResponse wrapper for the GetGenericArtifactContent operation
func (GetGenericArtifactContentResponse) HTTPResponse ¶
func (response GetGenericArtifactContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetGenericArtifactContentResponse) String ¶
func (response GetGenericArtifactContentResponse) String() string
type PutGenericArtifactContentByPathRequest ¶
type PutGenericArtifactContentByPathRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.
// Example: `ocid1.repository.oc1..exampleuniqueID`
RepositoryId *string `mandatory:"true" contributesTo:"path" name:"repositoryId"`
// A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.
// Example: `project01/my-web-app/artifact-abc`
ArtifactPath *string `mandatory:"true" contributesTo:"path" name:"artifactPath"`
// A user-defined string to describe the artifact version.
// Example: `1.1.2` or `1.2-beta-2`
Version *string `mandatory:"true" contributesTo:"path" name:"version"`
// Uploads an artifact. Provide artifact path, version and content. Avoid entering confidential information when you define the path and version.
GenericArtifactContentBody io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the `etag` from a previous GET or POST response for that resource. The resource will be updated or deleted only if the `etag` you provide matches the resource's current `etag` value. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned request ID (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm)
// Example: `bxxxxxxx-fxxx-4xxx-9xxx-bxxxxxxxxxxx`
// If you contact Oracle about a request, provide this request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
PutGenericArtifactContentByPathRequest wrapper for the PutGenericArtifactContentByPath operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/genericartifactscontent/PutGenericArtifactContentByPath.go.html to see an example of how to use PutGenericArtifactContentByPathRequest.
func (PutGenericArtifactContentByPathRequest) BinaryRequestBody ¶
func (request PutGenericArtifactContentByPathRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (PutGenericArtifactContentByPathRequest) HTTPRequest ¶
func (request PutGenericArtifactContentByPathRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (PutGenericArtifactContentByPathRequest) RetryPolicy ¶
func (request PutGenericArtifactContentByPathRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (PutGenericArtifactContentByPathRequest) String ¶
func (request PutGenericArtifactContentByPathRequest) String() string
type PutGenericArtifactContentByPathResponse ¶
type PutGenericArtifactContentByPathResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenericArtifact instance
GenericArtifact `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
PutGenericArtifactContentByPathResponse wrapper for the PutGenericArtifactContentByPath operation
func (PutGenericArtifactContentByPathResponse) HTTPResponse ¶
func (response PutGenericArtifactContentByPathResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (PutGenericArtifactContentByPathResponse) String ¶
func (response PutGenericArtifactContentByPathResponse) String() string