Package animeshon.release.v1alpha1

Index

• Publisher

• CancelReleaseRequest

• CancelReleaseResponse

• CreateReleaseRequest

• DeleteReleaseRequest

• GetReleaseRequest

• ListReleasesRequest

• ListReleasesResponse

• PublishReleaseRequest

• PublishReleaseResponse

• Release

• Release.LabelsEntry

• ReleaseStrategy

• ScheduleReleaseRequest

• ScheduleReleaseResponse

• SuspendReleaseRequest

• SuspendReleaseResponse

• UndeleteReleaseRequest

• UnpublishReleaseRequest

• UnpublishReleaseResponse

• UpdateReleaseRequest

• Release.State

• Visibility

Publisher

GetRelease
rpc GetRelease(GetReleaseRequest) Release

ListReleases
rpc ListReleases(ListReleasesRequest) ListReleasesResponse

CreateRelease
rpc CreateRelease(CreateReleaseRequest) Release

UpdateRelease
rpc UpdateRelease(UpdateReleaseRequest) Release

DeleteRelease
rpc DeleteRelease(DeleteReleaseRequest) .google.protobuf.Empty The release is soft-deleted and a grace period is granted before complete deletion. During this grace period the release can be recovered.

UndeleteRelease
rpc UndeleteRelease(UndeleteReleaseRequest) Release This method allows to recover a release while still in the grace period.

PublishRelease
rpc PublishRelease(PublishReleaseRequest) PublishReleaseResponse The release is marked as immediately available to the public.

UnpublishRelease
rpc UnpublishRelease(UnpublishReleaseRequest) UnpublishReleaseResponse The release is unpublished and marked as a draft, associated non-authoritative will automatically be marked as suspended and hidden from the general public.

ScheduleRelease
rpc ScheduleRelease(ScheduleReleaseRequest) ScheduleReleaseResponse The release is scheduled to be released at a specific future date and time.

CancelRelease
rpc CancelRelease(CancelReleaseRequest) CancelReleaseResponse This method can only be called on scheduled releases. The scheduling is cancelled and the release is marked as a draft.

SuspendRelease
rpc SuspendRelease(SuspendReleaseRequest) SuspendReleaseResponse This method can only be called on published releases marked as active. Any non-authoritative release associated to the specified release will also be automatically marked as suspended.

CancelReleaseRequest

Field	Description
name	string The name of the release to cancel.

CancelReleaseResponse

CreateReleaseRequest

Field	Description
parent	string The parent this release belongs to.
release	Release The release to create.
ttl	google.protobuf.Duration The time-to-live indicating for how long this release should be published. If set to zero, the release will not have an expiration time.

DeleteReleaseRequest

Field	Description
name	string The name of the release to delete.

GetReleaseRequest

Field	Description
name	string The name of the release to retrieve.

ListReleasesRequest

Field	Description
parent	string The parent to list releases from.
page_size	int32 If unspecified, server will pick an appropriate default.
page_token	string The value returned from the previous call.
filter	string A filter to be applied to results.

ListReleasesResponse

Field	Description
releases	repeated Release The list of releases.
next_page_token	string A token to retrieve next page of results.

PublishReleaseRequest

Field	Description
name	string The name of the release to publish.
strategy	ReleaseStrategy The release strategy to use.

PublishReleaseResponse

Release

Field	Description
name	string The release resource name.
display_name	string The human-readable display name of the release.
description	string The short description of the release.
authoritative_release	string The authoritative release is set only for sub-licensed releases that do not hold any publishing rights on the content being distributed.

A common case where the release is to be considered non-authoritative is a translation released by third-parties. In such scenario the original author(s) is to be considered the only publishing authority over the content.

If for any reason the authoritative release were to be unpublished or deleted from Animeshon all associated non-authoritative releases will be automatically hidden from public consumption and marked as suspended.

Furthermore, there can only be one authoritative release per resource, which means that you can have unlimited non-authoritative releases for one resource but it must have exactly one authoritative release. | | resource | string
The resource being released. | | asset | string
The product included in the release. | | access_group | string
The group of users authorized to access the asset. | | visibility | Visibility
The visibility of the resources included in the asset. | | state | Release.State
The current release state. | | labels | map Release.LabelsEntry
The map of labels associated with the release. | | create_time | google.protobuf.Timestamp
The timestamp at which the release was created. | | update_time | google.protobuf.Timestamp
The latest timestamp at which the release was updated. | | expire_time | google.protobuf.Timestamp
The timestamp at which the release will expire. | | delete_time | google.protobuf.Timestamp
The timestamp at which the release was deleted. |

Release.LabelsEntry

Field	Description
key	string
value	string

ReleaseStrategy

The release strategy describes how a release should be published.

Field	Description
membership_only	bool Whether the release should be available only to the members of a group.

ScheduleReleaseRequest

Field	Description
name	string The name of the release to schedule.
strategy	ReleaseStrategy The release strategy to use.

ScheduleReleaseResponse

SuspendReleaseRequest

Field	Description
name	string The name of the release to suspend.
reason	string The reason why the release has been suspended.

SuspendReleaseResponse

UndeleteReleaseRequest

Field	Description
name	string The name of the release to undelete.

UnpublishReleaseRequest

Field	Description
name	string The name of the release to publish.

UnpublishReleaseResponse

UpdateReleaseRequest

Field	Description
release	Release The release to update.
update_mask	google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

Release.State

Name	Description
STATE_UNSPECIFIED	The default value. This value is used if the state is omitted.
ACTIVE	The release has been published and is available to the general public.
SCHEDULED	The release has been scheduled and will be made automatically available to the public according to the scheduling conditions.
DRAFT	The release is a draft and is still being worked on.
SUSPENDED	The release has been suspended. This state might automatically being set for non-authoritative releases when their authoritative release is also suspended, unpublished, or deleted. This state might also be set when a release is breaching general terms and conditions or is in conflict with community guidelines or internal governing policies.
DELETED	The release has been marked for deletion.

Visibility

Name	Description
VISIBILITY_UNSPECIFIED	The default value. This value is used if the state is omitted.
PRIVATE	The release is private and can only be accessed by users and service accounts that have been granted direct access to the release resource via explicit or inherited IAM policies.
MEMBERSHIP	The release has been published and access to its assets is limited to members that have paid the membership fee (e.g. a user who has bought the release).
PUBLIC	The release has been published and all of its assets are publicly available to all users.